/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: 2016-06-21 19:13:11 UTC
  • Revision ID: teddy@recompile.se-20160621191311-cdyg3jniktde5wfr
Fix "bad gpgme_op_decrypt: GPGME: Decryption failed." on boot.

* initramfs-tools-hook: Also copy_exec gpg-agent if it exists.

Closes: 819982
Reported-by: Felix Koop <fdp@fkoop.de>
Suggested-by: Anonymous

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-2016 Teddy Hogeborn
 
15
# Copyright © 2008-2016 Björn Påhlsson
16
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
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
 
import SocketServer as socketserver
 
42
try:
 
43
    import SocketServer as socketserver
 
44
except ImportError:
 
45
    import socketserver
40
46
import socket
41
47
import argparse
42
48
import datetime
43
49
import errno
44
 
import gnutls.crypto
45
 
import gnutls.connection
46
 
import gnutls.errors
47
 
import gnutls.library.functions
48
 
import gnutls.library.constants
49
 
import gnutls.library.types
50
 
import ConfigParser as configparser
 
50
try:
 
51
    import ConfigParser as configparser
 
52
except ImportError:
 
53
    import configparser
51
54
import sys
52
55
import re
53
56
import os
62
65
import struct
63
66
import fcntl
64
67
import functools
65
 
import cPickle as pickle
 
68
try:
 
69
    import cPickle as pickle
 
70
except ImportError:
 
71
    import pickle
66
72
import multiprocessing
67
73
import types
68
74
import binascii
69
75
import tempfile
70
76
import itertools
71
77
import collections
 
78
import codecs
72
79
 
73
80
import dbus
74
81
import dbus.service
75
 
import gobject
76
 
import avahi
 
82
from gi.repository import GLib
77
83
from dbus.mainloop.glib import DBusGMainLoop
78
84
import ctypes
79
85
import ctypes.util
80
86
import xml.dom.minidom
81
87
import inspect
82
88
 
 
89
# Try to find the value of SO_BINDTODEVICE:
83
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:
84
93
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
94
except AttributeError:
86
95
    try:
 
96
        # This is where SO_BINDTODEVICE was up to and including Python
 
97
        # 2.6, and also 3.2:
87
98
        from IN import SO_BINDTODEVICE
88
99
    except ImportError:
89
 
        SO_BINDTODEVICE = None
90
 
 
91
 
version = "1.6.5"
 
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
 
113
 
 
114
if sys.version_info.major == 2:
 
115
    str = unicode
 
116
 
 
117
version = "1.7.7"
92
118
stored_state_file = "clients.pickle"
93
119
 
94
120
logger = logging.getLogger()
95
121
syslogger = None
96
122
 
97
123
try:
98
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
99
 
                      (ctypes.util.find_library("c"))
100
 
                      .if_nametoindex)
 
124
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
125
        ctypes.util.find_library("c")).if_nametoindex
101
126
except (OSError, AttributeError):
 
127
    
102
128
    def if_nametoindex(interface):
103
129
        "Get an interface index the hard way, i.e. using fcntl()"
104
130
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
131
        with contextlib.closing(socket.socket()) as s:
106
132
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
 
133
                                struct.pack(b"16s16x", interface))
 
134
        interface_index = struct.unpack("I", ifreq[16:20])[0]
111
135
        return interface_index
112
136
 
113
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
 
114
154
def initlogger(debug, level=logging.WARNING):
115
155
    """init logger and add loglevel"""
116
156
    
117
157
    global syslogger
118
 
    syslogger = (logging.handlers.SysLogHandler
119
 
                 (facility =
120
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
121
 
                  address = str("/dev/log")))
 
158
    syslogger = (logging.handlers.SysLogHandler(
 
159
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
160
        address = "/dev/log"))
122
161
    syslogger.setFormatter(logging.Formatter
123
162
                           ('Mandos [%(process)d]: %(levelname)s:'
124
163
                            ' %(message)s'))
141
180
 
142
181
class PGPEngine(object):
143
182
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
183
    
144
184
    def __init__(self):
145
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
146
197
        self.gnupgargs = ['--batch',
147
 
                          '--home', self.tempdir,
 
198
                          '--homedir', self.tempdir,
148
199
                          '--force-mdc',
149
 
                          '--quiet',
150
 
                          '--no-use-agent']
 
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")
151
204
    
152
205
    def __enter__(self):
153
206
        return self
185
238
    
186
239
    def encrypt(self, data, password):
187
240
        passphrase = self.password_encode(password)
188
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
189
 
                                         ) as passfile:
 
241
        with tempfile.NamedTemporaryFile(
 
242
                dir=self.tempdir) as passfile:
190
243
            passfile.write(passphrase)
191
244
            passfile.flush()
192
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
245
            proc = subprocess.Popen([self.gpg, '--symmetric',
193
246
                                     '--passphrase-file',
194
247
                                     passfile.name]
195
248
                                    + self.gnupgargs,
203
256
    
204
257
    def decrypt(self, data, password):
205
258
        passphrase = self.password_encode(password)
206
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
207
 
                                         ) as passfile:
 
259
        with tempfile.NamedTemporaryFile(
 
260
                dir = self.tempdir) as passfile:
208
261
            passfile.write(passphrase)
209
262
            passfile.flush()
210
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
263
            proc = subprocess.Popen([self.gpg, '--decrypt',
211
264
                                     '--passphrase-file',
212
265
                                     passfile.name]
213
266
                                    + self.gnupgargs,
214
267
                                    stdin = subprocess.PIPE,
215
268
                                    stdout = subprocess.PIPE,
216
269
                                    stderr = subprocess.PIPE)
217
 
            decrypted_plaintext, err = proc.communicate(input
218
 
                                                        = data)
 
270
            decrypted_plaintext, err = proc.communicate(input = data)
219
271
        if proc.returncode != 0:
220
272
            raise PGPError(err)
221
273
        return decrypted_plaintext
222
274
 
 
275
# Pretend that we have an Avahi module
 
276
class Avahi(object):
 
277
    """This isn't so much a class as it is a module-like namespace.
 
278
    It is instantiated once, and simulates having an Avahi module."""
 
279
    IF_UNSPEC = -1              # avahi-common/address.h
 
280
    PROTO_UNSPEC = -1           # avahi-common/address.h
 
281
    PROTO_INET = 0              # avahi-common/address.h
 
282
    PROTO_INET6 = 1             # avahi-common/address.h
 
283
    DBUS_NAME = "org.freedesktop.Avahi"
 
284
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
285
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
286
    DBUS_PATH_SERVER = "/"
 
287
    def string_array_to_txt_array(self, t):
 
288
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
 
289
                           for s in t), signature="ay")
 
290
    ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
 
291
    ENTRY_GROUP_COLLISION = 3   # avahi-common/defs.h
 
292
    ENTRY_GROUP_FAILURE = 4     # avahi-common/defs.h
 
293
    SERVER_INVALID = 0          # avahi-common/defs.h
 
294
    SERVER_REGISTERING = 1      # avahi-common/defs.h
 
295
    SERVER_RUNNING = 2          # avahi-common/defs.h
 
296
    SERVER_COLLISION = 3        # avahi-common/defs.h
 
297
    SERVER_FAILURE = 4          # avahi-common/defs.h
 
298
avahi = Avahi()
223
299
 
224
300
class AvahiError(Exception):
225
301
    def __init__(self, value, *args, **kwargs):
226
302
        self.value = value
227
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
228
 
    def __unicode__(self):
229
 
        return unicode(repr(self.value))
 
303
        return super(AvahiError, self).__init__(value, *args,
 
304
                                                **kwargs)
 
305
 
230
306
 
231
307
class AvahiServiceError(AvahiError):
232
308
    pass
233
309
 
 
310
 
234
311
class AvahiGroupError(AvahiError):
235
312
    pass
236
313
 
256
333
    bus: dbus.SystemBus()
257
334
    """
258
335
    
259
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
 
                 servicetype = None, port = None, TXT = None,
261
 
                 domain = "", host = "", max_renames = 32768,
262
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
336
    def __init__(self,
 
337
                 interface = avahi.IF_UNSPEC,
 
338
                 name = None,
 
339
                 servicetype = None,
 
340
                 port = None,
 
341
                 TXT = None,
 
342
                 domain = "",
 
343
                 host = "",
 
344
                 max_renames = 32768,
 
345
                 protocol = avahi.PROTO_UNSPEC,
 
346
                 bus = None):
263
347
        self.interface = interface
264
348
        self.name = name
265
349
        self.type = servicetype
275
359
        self.bus = bus
276
360
        self.entry_group_state_changed_match = None
277
361
    
278
 
    def rename(self):
 
362
    def rename(self, remove=True):
279
363
        """Derived from the Avahi example code"""
280
364
        if self.rename_count >= self.max_renames:
281
365
            logger.critical("No suitable Zeroconf service name found"
282
366
                            " after %i retries, exiting.",
283
367
                            self.rename_count)
284
368
            raise AvahiServiceError("Too many renames")
285
 
        self.name = unicode(self.server
286
 
                            .GetAlternativeServiceName(self.name))
 
369
        self.name = str(
 
370
            self.server.GetAlternativeServiceName(self.name))
 
371
        self.rename_count += 1
287
372
        logger.info("Changing Zeroconf service name to %r ...",
288
373
                    self.name)
289
 
        self.remove()
 
374
        if remove:
 
375
            self.remove()
290
376
        try:
291
377
            self.add()
292
378
        except dbus.exceptions.DBusException as error:
293
 
            logger.critical("D-Bus Exception", exc_info=error)
294
 
            self.cleanup()
295
 
            os._exit(1)
296
 
        self.rename_count += 1
 
379
            if (error.get_dbus_name()
 
380
                == "org.freedesktop.Avahi.CollisionError"):
 
381
                logger.info("Local Zeroconf service name collision.")
 
382
                return self.rename(remove=False)
 
383
            else:
 
384
                logger.critical("D-Bus Exception", exc_info=error)
 
385
                self.cleanup()
 
386
                os._exit(1)
297
387
    
298
388
    def remove(self):
299
389
        """Derived from the Avahi example code"""
337
427
            self.rename()
338
428
        elif state == avahi.ENTRY_GROUP_FAILURE:
339
429
            logger.critical("Avahi: Error in group state changed %s",
340
 
                            unicode(error))
341
 
            raise AvahiGroupError("State changed: {0!s}"
342
 
                                  .format(error))
 
430
                            str(error))
 
431
            raise AvahiGroupError("State changed: {!s}".format(error))
343
432
    
344
433
    def cleanup(self):
345
434
        """Derived from the Avahi example code"""
355
444
    def server_state_changed(self, state, error=None):
356
445
        """Derived from the Avahi example code"""
357
446
        logger.debug("Avahi server state change: %i", state)
358
 
        bad_states = { avahi.SERVER_INVALID:
359
 
                           "Zeroconf server invalid",
360
 
                       avahi.SERVER_REGISTERING: None,
361
 
                       avahi.SERVER_COLLISION:
362
 
                           "Zeroconf server name collision",
363
 
                       avahi.SERVER_FAILURE:
364
 
                           "Zeroconf server failure" }
 
447
        bad_states = {
 
448
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
449
            avahi.SERVER_REGISTERING: None,
 
450
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
451
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
452
        }
365
453
        if state in bad_states:
366
454
            if bad_states[state] is not None:
367
455
                if error is None:
370
458
                    logger.error(bad_states[state] + ": %r", error)
371
459
            self.cleanup()
372
460
        elif state == avahi.SERVER_RUNNING:
373
 
            self.add()
 
461
            try:
 
462
                self.add()
 
463
            except dbus.exceptions.DBusException as error:
 
464
                if (error.get_dbus_name()
 
465
                    == "org.freedesktop.Avahi.CollisionError"):
 
466
                    logger.info("Local Zeroconf service name"
 
467
                                " collision.")
 
468
                    return self.rename(remove=False)
 
469
                else:
 
470
                    logger.critical("D-Bus Exception", exc_info=error)
 
471
                    self.cleanup()
 
472
                    os._exit(1)
374
473
        else:
375
474
            if error is None:
376
475
                logger.debug("Unknown state: %r", state)
386
485
                                    follow_name_owner_changes=True),
387
486
                avahi.DBUS_INTERFACE_SERVER)
388
487
        self.server.connect_to_signal("StateChanged",
389
 
                                 self.server_state_changed)
 
488
                                      self.server_state_changed)
390
489
        self.server_state_changed(self.server.GetState())
391
490
 
392
491
 
393
492
class AvahiServiceToSyslog(AvahiService):
394
 
    def rename(self):
 
493
    def rename(self, *args, **kwargs):
395
494
        """Add the new name to the syslog messages"""
396
 
        ret = AvahiService.rename(self)
397
 
        syslogger.setFormatter(logging.Formatter
398
 
                               ('Mandos ({0}) [%(process)d]:'
399
 
                                ' %(levelname)s: %(message)s'
400
 
                                .format(self.name)))
 
495
        ret = AvahiService.rename(self, *args, **kwargs)
 
496
        syslogger.setFormatter(logging.Formatter(
 
497
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
498
            .format(self.name)))
401
499
        return ret
402
500
 
403
 
 
404
 
def timedelta_to_milliseconds(td):
405
 
    "Convert a datetime.timedelta() to milliseconds"
406
 
    return ((td.days * 24 * 60 * 60 * 1000)
407
 
            + (td.seconds * 1000)
408
 
            + (td.microseconds // 1000))
409
 
 
 
501
# Pretend that we have a GnuTLS module
 
502
class GnuTLS(object):
 
503
    """This isn't so much a class as it is a module-like namespace.
 
504
    It is instantiated once, and simulates having a GnuTLS module."""
 
505
    
 
506
    _library = ctypes.cdll.LoadLibrary(
 
507
        ctypes.util.find_library("gnutls"))
 
508
    _need_version = b"3.3.0"
 
509
    def __init__(self):
 
510
        # Need to use class name "GnuTLS" here, since this method is
 
511
        # called before the assignment to the "gnutls" global variable
 
512
        # happens.
 
513
        if GnuTLS.check_version(self._need_version) is None:
 
514
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
515
                               .format(self._need_version))
 
516
    
 
517
    # Unless otherwise indicated, the constants and types below are
 
518
    # all from the gnutls/gnutls.h C header file.
 
519
    
 
520
    # Constants
 
521
    E_SUCCESS = 0
 
522
    E_INTERRUPTED = -52
 
523
    E_AGAIN = -28
 
524
    CRT_OPENPGP = 2
 
525
    CLIENT = 2
 
526
    SHUT_RDWR = 0
 
527
    CRD_CERTIFICATE = 1
 
528
    E_NO_CERTIFICATE_FOUND = -49
 
529
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
530
    
 
531
    # Types
 
532
    class session_int(ctypes.Structure):
 
533
        _fields_ = []
 
534
    session_t = ctypes.POINTER(session_int)
 
535
    class certificate_credentials_st(ctypes.Structure):
 
536
        _fields_ = []
 
537
    certificate_credentials_t = ctypes.POINTER(
 
538
        certificate_credentials_st)
 
539
    certificate_type_t = ctypes.c_int
 
540
    class datum_t(ctypes.Structure):
 
541
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
542
                    ('size', ctypes.c_uint)]
 
543
    class openpgp_crt_int(ctypes.Structure):
 
544
        _fields_ = []
 
545
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
546
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
 
547
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
548
    credentials_type_t = ctypes.c_int
 
549
    transport_ptr_t = ctypes.c_void_p
 
550
    close_request_t = ctypes.c_int
 
551
    
 
552
    # Exceptions
 
553
    class Error(Exception):
 
554
        # We need to use the class name "GnuTLS" here, since this
 
555
        # exception might be raised from within GnuTLS.__init__,
 
556
        # which is called before the assignment to the "gnutls"
 
557
        # global variable has happened.
 
558
        def __init__(self, message = None, code = None, args=()):
 
559
            # Default usage is by a message string, but if a return
 
560
            # code is passed, convert it to a string with
 
561
            # gnutls.strerror()
 
562
            self.code = code
 
563
            if message is None and code is not None:
 
564
                message = GnuTLS.strerror(code)
 
565
            return super(GnuTLS.Error, self).__init__(
 
566
                message, *args)
 
567
    
 
568
    class CertificateSecurityError(Error):
 
569
        pass
 
570
    
 
571
    # Classes
 
572
    class Credentials(object):
 
573
        def __init__(self):
 
574
            self._c_object = gnutls.certificate_credentials_t()
 
575
            gnutls.certificate_allocate_credentials(
 
576
                ctypes.byref(self._c_object))
 
577
            self.type = gnutls.CRD_CERTIFICATE
 
578
        
 
579
        def __del__(self):
 
580
            gnutls.certificate_free_credentials(self._c_object)
 
581
    
 
582
    class ClientSession(object):
 
583
        def __init__(self, socket, credentials = None):
 
584
            self._c_object = gnutls.session_t()
 
585
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
586
            gnutls.set_default_priority(self._c_object)
 
587
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
588
            gnutls.handshake_set_private_extensions(self._c_object,
 
589
                                                    True)
 
590
            self.socket = socket
 
591
            if credentials is None:
 
592
                credentials = gnutls.Credentials()
 
593
            gnutls.credentials_set(self._c_object, credentials.type,
 
594
                                   ctypes.cast(credentials._c_object,
 
595
                                               ctypes.c_void_p))
 
596
            self.credentials = credentials
 
597
        
 
598
        def __del__(self):
 
599
            gnutls.deinit(self._c_object)
 
600
        
 
601
        def handshake(self):
 
602
            return gnutls.handshake(self._c_object)
 
603
        
 
604
        def send(self, data):
 
605
            data = bytes(data)
 
606
            data_len = len(data)
 
607
            while data_len > 0:
 
608
                data_len -= gnutls.record_send(self._c_object,
 
609
                                               data[-data_len:],
 
610
                                               data_len)
 
611
        
 
612
        def bye(self):
 
613
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
614
    
 
615
    # Error handling functions
 
616
    def _error_code(result):
 
617
        """A function to raise exceptions on errors, suitable
 
618
        for the 'restype' attribute on ctypes functions"""
 
619
        if result >= 0:
 
620
            return result
 
621
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
622
            raise gnutls.CertificateSecurityError(code = result)
 
623
        raise gnutls.Error(code = result)
 
624
    
 
625
    def _retry_on_error(result, func, arguments):
 
626
        """A function to retry on some errors, suitable
 
627
        for the 'errcheck' attribute on ctypes functions"""
 
628
        while result < 0:
 
629
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
630
                return _error_code(result)
 
631
            result = func(*arguments)
 
632
        return result
 
633
    
 
634
    # Unless otherwise indicated, the function declarations below are
 
635
    # all from the gnutls/gnutls.h C header file.
 
636
    
 
637
    # Functions
 
638
    priority_set_direct = _library.gnutls_priority_set_direct
 
639
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
640
                                    ctypes.POINTER(ctypes.c_char_p)]
 
641
    priority_set_direct.restype = _error_code
 
642
    
 
643
    init = _library.gnutls_init
 
644
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
645
    init.restype = _error_code
 
646
    
 
647
    set_default_priority = _library.gnutls_set_default_priority
 
648
    set_default_priority.argtypes = [session_t]
 
649
    set_default_priority.restype = _error_code
 
650
    
 
651
    record_send = _library.gnutls_record_send
 
652
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
653
                            ctypes.c_size_t]
 
654
    record_send.restype = ctypes.c_ssize_t
 
655
    record_send.errcheck = _retry_on_error
 
656
    
 
657
    certificate_allocate_credentials = (
 
658
        _library.gnutls_certificate_allocate_credentials)
 
659
    certificate_allocate_credentials.argtypes = [
 
660
        ctypes.POINTER(certificate_credentials_t)]
 
661
    certificate_allocate_credentials.restype = _error_code
 
662
    
 
663
    certificate_free_credentials = (
 
664
        _library.gnutls_certificate_free_credentials)
 
665
    certificate_free_credentials.argtypes = [certificate_credentials_t]
 
666
    certificate_free_credentials.restype = None
 
667
    
 
668
    handshake_set_private_extensions = (
 
669
        _library.gnutls_handshake_set_private_extensions)
 
670
    handshake_set_private_extensions.argtypes = [session_t,
 
671
                                                 ctypes.c_int]
 
672
    handshake_set_private_extensions.restype = None
 
673
    
 
674
    credentials_set = _library.gnutls_credentials_set
 
675
    credentials_set.argtypes = [session_t, credentials_type_t,
 
676
                                ctypes.c_void_p]
 
677
    credentials_set.restype = _error_code
 
678
    
 
679
    strerror = _library.gnutls_strerror
 
680
    strerror.argtypes = [ctypes.c_int]
 
681
    strerror.restype = ctypes.c_char_p
 
682
    
 
683
    certificate_type_get = _library.gnutls_certificate_type_get
 
684
    certificate_type_get.argtypes = [session_t]
 
685
    certificate_type_get.restype = _error_code
 
686
    
 
687
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
688
    certificate_get_peers.argtypes = [session_t,
 
689
                                      ctypes.POINTER(ctypes.c_uint)]
 
690
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
691
    
 
692
    global_set_log_level = _library.gnutls_global_set_log_level
 
693
    global_set_log_level.argtypes = [ctypes.c_int]
 
694
    global_set_log_level.restype = None
 
695
    
 
696
    global_set_log_function = _library.gnutls_global_set_log_function
 
697
    global_set_log_function.argtypes = [log_func]
 
698
    global_set_log_function.restype = None
 
699
    
 
700
    deinit = _library.gnutls_deinit
 
701
    deinit.argtypes = [session_t]
 
702
    deinit.restype = None
 
703
    
 
704
    handshake = _library.gnutls_handshake
 
705
    handshake.argtypes = [session_t]
 
706
    handshake.restype = _error_code
 
707
    handshake.errcheck = _retry_on_error
 
708
    
 
709
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
710
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
711
    transport_set_ptr.restype = None
 
712
    
 
713
    bye = _library.gnutls_bye
 
714
    bye.argtypes = [session_t, close_request_t]
 
715
    bye.restype = _error_code
 
716
    bye.errcheck = _retry_on_error
 
717
    
 
718
    check_version = _library.gnutls_check_version
 
719
    check_version.argtypes = [ctypes.c_char_p]
 
720
    check_version.restype = ctypes.c_char_p
 
721
    
 
722
    # All the function declarations below are from gnutls/openpgp.h
 
723
    
 
724
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
725
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
726
    openpgp_crt_init.restype = _error_code
 
727
    
 
728
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
729
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
730
                                   ctypes.POINTER(datum_t),
 
731
                                   openpgp_crt_fmt_t]
 
732
    openpgp_crt_import.restype = _error_code
 
733
    
 
734
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
735
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
736
                                        ctypes.POINTER(ctypes.c_uint)]
 
737
    openpgp_crt_verify_self.restype = _error_code
 
738
    
 
739
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
740
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
741
    openpgp_crt_deinit.restype = None
 
742
    
 
743
    openpgp_crt_get_fingerprint = (
 
744
        _library.gnutls_openpgp_crt_get_fingerprint)
 
745
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
746
                                            ctypes.c_void_p,
 
747
                                            ctypes.POINTER(
 
748
                                                ctypes.c_size_t)]
 
749
    openpgp_crt_get_fingerprint.restype = _error_code
 
750
    
 
751
    # Remove non-public functions
 
752
    del _error_code, _retry_on_error
 
753
# Create the global "gnutls" object, simulating a module
 
754
gnutls = GnuTLS()
 
755
 
 
756
def call_pipe(connection,       # : multiprocessing.Connection
 
757
              func, *args, **kwargs):
 
758
    """This function is meant to be called by multiprocessing.Process
 
759
    
 
760
    This function runs func(*args, **kwargs), and writes the resulting
 
761
    return value on the provided multiprocessing.Connection.
 
762
    """
 
763
    connection.send(func(*args, **kwargs))
 
764
    connection.close()
410
765
 
411
766
class Client(object):
412
767
    """A representation of a client host served by this server.
418
773
    checker:    subprocess.Popen(); a running checker process used
419
774
                                    to see if the client lives.
420
775
                                    'None' if no process is running.
421
 
    checker_callback_tag: a gobject event source tag, or None
 
776
    checker_callback_tag: a GLib event source tag, or None
422
777
    checker_command: string; External command which is run to check
423
778
                     if client lives.  %() expansions are done at
424
779
                     runtime with vars(self) as dict, so that for
425
780
                     instance %(name)s can be used in the command.
426
 
    checker_initiator_tag: a gobject event source tag, or None
 
781
    checker_initiator_tag: a GLib event source tag, or None
427
782
    created:    datetime.datetime(); (UTC) object creation
428
783
    client_structure: Object describing what attributes a client has
429
784
                      and is used for storing the client at exit
430
785
    current_checker_command: string; current running checker_command
431
 
    disable_initiator_tag: a gobject event source tag, or None
 
786
    disable_initiator_tag: a GLib event source tag, or None
432
787
    enabled:    bool()
433
788
    fingerprint: string (40 or 32 hexadecimal digits); used to
434
789
                 uniquely identify the client
439
794
    last_checker_status: integer between 0 and 255 reflecting exit
440
795
                         status of last checker. -1 reflects crashed
441
796
                         checker, -2 means no checker completed yet.
 
797
    last_checker_signal: The signal which killed the last checker, if
 
798
                         last_checker_status is -1
442
799
    last_enabled: datetime.datetime(); (UTC) or None
443
800
    name:       string; from the config file, used in log messages and
444
801
                        D-Bus identifiers
457
814
                          "fingerprint", "host", "interval",
458
815
                          "last_approval_request", "last_checked_ok",
459
816
                          "last_enabled", "name", "timeout")
460
 
    client_defaults = { "timeout": "PT5M",
461
 
                        "extended_timeout": "PT15M",
462
 
                        "interval": "PT2M",
463
 
                        "checker": "fping -q -- %%(host)s",
464
 
                        "host": "",
465
 
                        "approval_delay": "PT0S",
466
 
                        "approval_duration": "PT1S",
467
 
                        "approved_by_default": "True",
468
 
                        "enabled": "True",
469
 
                        }
470
 
    
471
 
    def timeout_milliseconds(self):
472
 
        "Return the 'timeout' attribute in milliseconds"
473
 
        return timedelta_to_milliseconds(self.timeout)
474
 
    
475
 
    def extended_timeout_milliseconds(self):
476
 
        "Return the 'extended_timeout' attribute in milliseconds"
477
 
        return timedelta_to_milliseconds(self.extended_timeout)
478
 
    
479
 
    def interval_milliseconds(self):
480
 
        "Return the 'interval' attribute in milliseconds"
481
 
        return timedelta_to_milliseconds(self.interval)
482
 
    
483
 
    def approval_delay_milliseconds(self):
484
 
        return timedelta_to_milliseconds(self.approval_delay)
 
817
    client_defaults = {
 
818
        "timeout": "PT5M",
 
819
        "extended_timeout": "PT15M",
 
820
        "interval": "PT2M",
 
821
        "checker": "fping -q -- %%(host)s",
 
822
        "host": "",
 
823
        "approval_delay": "PT0S",
 
824
        "approval_duration": "PT1S",
 
825
        "approved_by_default": "True",
 
826
        "enabled": "True",
 
827
    }
485
828
    
486
829
    @staticmethod
487
830
    def config_parser(config):
503
846
            client["enabled"] = config.getboolean(client_name,
504
847
                                                  "enabled")
505
848
            
 
849
            # Uppercase and remove spaces from fingerprint for later
 
850
            # comparison purposes with return value from the
 
851
            # fingerprint() function
506
852
            client["fingerprint"] = (section["fingerprint"].upper()
507
853
                                     .replace(" ", ""))
508
854
            if "secret" in section:
509
 
                client["secret"] = section["secret"].decode("base64")
 
855
                client["secret"] = codecs.decode(section["secret"]
 
856
                                                 .encode("utf-8"),
 
857
                                                 "base64")
510
858
            elif "secfile" in section:
511
859
                with open(os.path.expanduser(os.path.expandvars
512
860
                                             (section["secfile"])),
513
861
                          "rb") as secfile:
514
862
                    client["secret"] = secfile.read()
515
863
            else:
516
 
                raise TypeError("No secret or secfile for section {0}"
 
864
                raise TypeError("No secret or secfile for section {}"
517
865
                                .format(section))
518
866
            client["timeout"] = string_to_delta(section["timeout"])
519
867
            client["extended_timeout"] = string_to_delta(
536
884
            server_settings = {}
537
885
        self.server_settings = server_settings
538
886
        # adding all client settings
539
 
        for setting, value in settings.iteritems():
 
887
        for setting, value in settings.items():
540
888
            setattr(self, setting, value)
541
889
        
542
890
        if self.enabled:
550
898
            self.expires = None
551
899
        
552
900
        logger.debug("Creating client %r", self.name)
553
 
        # Uppercase and remove spaces from fingerprint for later
554
 
        # comparison purposes with return value from the fingerprint()
555
 
        # function
556
901
        logger.debug("  Fingerprint: %s", self.fingerprint)
557
902
        self.created = settings.get("created",
558
903
                                    datetime.datetime.utcnow())
565
910
        self.current_checker_command = None
566
911
        self.approved = None
567
912
        self.approvals_pending = 0
568
 
        self.changedstate = (multiprocessing_manager
569
 
                             .Condition(multiprocessing_manager
570
 
                                        .Lock()))
571
 
        self.client_structure = [attr for attr in
572
 
                                 self.__dict__.iterkeys()
 
913
        self.changedstate = multiprocessing_manager.Condition(
 
914
            multiprocessing_manager.Lock())
 
915
        self.client_structure = [attr
 
916
                                 for attr in self.__dict__.keys()
573
917
                                 if not attr.startswith("_")]
574
918
        self.client_structure.append("client_structure")
575
919
        
576
 
        for name, t in inspect.getmembers(type(self),
577
 
                                          lambda obj:
578
 
                                              isinstance(obj,
579
 
                                                         property)):
 
920
        for name, t in inspect.getmembers(
 
921
                type(self), lambda obj: isinstance(obj, property)):
580
922
            if not name.startswith("_"):
581
923
                self.client_structure.append(name)
582
924
    
603
945
        if not quiet:
604
946
            logger.info("Disabling client %s", self.name)
605
947
        if getattr(self, "disable_initiator_tag", None) is not None:
606
 
            gobject.source_remove(self.disable_initiator_tag)
 
948
            GLib.source_remove(self.disable_initiator_tag)
607
949
            self.disable_initiator_tag = None
608
950
        self.expires = None
609
951
        if getattr(self, "checker_initiator_tag", None) is not None:
610
 
            gobject.source_remove(self.checker_initiator_tag)
 
952
            GLib.source_remove(self.checker_initiator_tag)
611
953
            self.checker_initiator_tag = None
612
954
        self.stop_checker()
613
955
        self.enabled = False
614
956
        if not quiet:
615
957
            self.send_changedstate()
616
 
        # Do not run this again if called by a gobject.timeout_add
 
958
        # Do not run this again if called by a GLib.timeout_add
617
959
        return False
618
960
    
619
961
    def __del__(self):
623
965
        # Schedule a new checker to be started an 'interval' from now,
624
966
        # and every interval from then on.
625
967
        if self.checker_initiator_tag is not None:
626
 
            gobject.source_remove(self.checker_initiator_tag)
627
 
        self.checker_initiator_tag = (gobject.timeout_add
628
 
                                      (self.interval_milliseconds(),
629
 
                                       self.start_checker))
 
968
            GLib.source_remove(self.checker_initiator_tag)
 
969
        self.checker_initiator_tag = GLib.timeout_add(
 
970
            int(self.interval.total_seconds() * 1000),
 
971
            self.start_checker)
630
972
        # Schedule a disable() when 'timeout' has passed
631
973
        if self.disable_initiator_tag is not None:
632
 
            gobject.source_remove(self.disable_initiator_tag)
633
 
        self.disable_initiator_tag = (gobject.timeout_add
634
 
                                   (self.timeout_milliseconds(),
635
 
                                    self.disable))
 
974
            GLib.source_remove(self.disable_initiator_tag)
 
975
        self.disable_initiator_tag = GLib.timeout_add(
 
976
            int(self.timeout.total_seconds() * 1000), self.disable)
636
977
        # Also start a new checker *right now*.
637
978
        self.start_checker()
638
979
    
639
 
    def checker_callback(self, pid, condition, command):
 
980
    def checker_callback(self, source, condition, connection,
 
981
                         command):
640
982
        """The checker has completed, so take appropriate actions."""
641
983
        self.checker_callback_tag = None
642
984
        self.checker = None
643
 
        if os.WIFEXITED(condition):
644
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
985
        # Read return code from connection (see call_pipe)
 
986
        returncode = connection.recv()
 
987
        connection.close()
 
988
        
 
989
        if returncode >= 0:
 
990
            self.last_checker_status = returncode
 
991
            self.last_checker_signal = None
645
992
            if self.last_checker_status == 0:
646
993
                logger.info("Checker for %(name)s succeeded",
647
994
                            vars(self))
648
995
                self.checked_ok()
649
996
            else:
650
 
                logger.info("Checker for %(name)s failed",
651
 
                            vars(self))
 
997
                logger.info("Checker for %(name)s failed", vars(self))
652
998
        else:
653
999
            self.last_checker_status = -1
 
1000
            self.last_checker_signal = -returncode
654
1001
            logger.warning("Checker for %(name)s crashed?",
655
1002
                           vars(self))
 
1003
        return False
656
1004
    
657
1005
    def checked_ok(self):
658
1006
        """Assert that the client has been seen, alive and well."""
659
1007
        self.last_checked_ok = datetime.datetime.utcnow()
660
1008
        self.last_checker_status = 0
 
1009
        self.last_checker_signal = None
661
1010
        self.bump_timeout()
662
1011
    
663
1012
    def bump_timeout(self, timeout=None):
665
1014
        if timeout is None:
666
1015
            timeout = self.timeout
667
1016
        if self.disable_initiator_tag is not None:
668
 
            gobject.source_remove(self.disable_initiator_tag)
 
1017
            GLib.source_remove(self.disable_initiator_tag)
669
1018
            self.disable_initiator_tag = None
670
1019
        if getattr(self, "enabled", False):
671
 
            self.disable_initiator_tag = (gobject.timeout_add
672
 
                                          (timedelta_to_milliseconds
673
 
                                           (timeout), self.disable))
 
1020
            self.disable_initiator_tag = GLib.timeout_add(
 
1021
                int(timeout.total_seconds() * 1000), self.disable)
674
1022
            self.expires = datetime.datetime.utcnow() + timeout
675
1023
    
676
1024
    def need_approval(self):
690
1038
        # than 'timeout' for the client to be disabled, which is as it
691
1039
        # should be.
692
1040
        
693
 
        # If a checker exists, make sure it is not a zombie
694
 
        try:
695
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
696
 
        except AttributeError:
697
 
            pass
698
 
        except OSError as error:
699
 
            if error.errno != errno.ECHILD:
700
 
                raise
701
 
        else:
702
 
            if pid:
703
 
                logger.warning("Checker was a zombie")
704
 
                gobject.source_remove(self.checker_callback_tag)
705
 
                self.checker_callback(pid, status,
706
 
                                      self.current_checker_command)
 
1041
        if self.checker is not None and not self.checker.is_alive():
 
1042
            logger.warning("Checker was not alive; joining")
 
1043
            self.checker.join()
 
1044
            self.checker = None
707
1045
        # Start a new checker if needed
708
1046
        if self.checker is None:
709
1047
            # Escape attributes for the shell
710
 
            escaped_attrs = dict(
711
 
                (attr, re.escape(unicode(getattr(self, attr))))
712
 
                for attr in
713
 
                self.runtime_expansions)
 
1048
            escaped_attrs = {
 
1049
                attr: re.escape(str(getattr(self, attr)))
 
1050
                for attr in self.runtime_expansions }
714
1051
            try:
715
1052
                command = self.checker_command % escaped_attrs
716
1053
            except TypeError as error:
717
1054
                logger.error('Could not format string "%s"',
718
 
                             self.checker_command, exc_info=error)
719
 
                return True # Try again later
 
1055
                             self.checker_command,
 
1056
                             exc_info=error)
 
1057
                return True     # Try again later
720
1058
            self.current_checker_command = command
721
 
            try:
722
 
                logger.info("Starting checker %r for %s",
723
 
                            command, self.name)
724
 
                # We don't need to redirect stdout and stderr, since
725
 
                # in normal mode, that is already done by daemon(),
726
 
                # and in debug mode we don't want to.  (Stdin is
727
 
                # always replaced by /dev/null.)
728
 
                # The exception is when not debugging but nevertheless
729
 
                # running in the foreground; use the previously
730
 
                # created wnull.
731
 
                popen_args = {}
732
 
                if (not self.server_settings["debug"]
733
 
                    and self.server_settings["foreground"]):
734
 
                    popen_args.update({"stdout": wnull,
735
 
                                       "stderr": wnull })
736
 
                self.checker = subprocess.Popen(command,
737
 
                                                close_fds=True,
738
 
                                                shell=True, cwd="/",
739
 
                                                **popen_args)
740
 
            except OSError as error:
741
 
                logger.error("Failed to start subprocess",
742
 
                             exc_info=error)
743
 
                return True
744
 
            self.checker_callback_tag = (gobject.child_watch_add
745
 
                                         (self.checker.pid,
746
 
                                          self.checker_callback,
747
 
                                          data=command))
748
 
            # The checker may have completed before the gobject
749
 
            # watch was added.  Check for this.
750
 
            try:
751
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
752
 
            except OSError as error:
753
 
                if error.errno == errno.ECHILD:
754
 
                    # This should never happen
755
 
                    logger.error("Child process vanished",
756
 
                                 exc_info=error)
757
 
                    return True
758
 
                raise
759
 
            if pid:
760
 
                gobject.source_remove(self.checker_callback_tag)
761
 
                self.checker_callback(pid, status, command)
762
 
        # Re-run this periodically if run by gobject.timeout_add
 
1059
            logger.info("Starting checker %r for %s", command,
 
1060
                        self.name)
 
1061
            # We don't need to redirect stdout and stderr, since
 
1062
            # in normal mode, that is already done by daemon(),
 
1063
            # and in debug mode we don't want to.  (Stdin is
 
1064
            # always replaced by /dev/null.)
 
1065
            # The exception is when not debugging but nevertheless
 
1066
            # running in the foreground; use the previously
 
1067
            # created wnull.
 
1068
            popen_args = { "close_fds": True,
 
1069
                           "shell": True,
 
1070
                           "cwd": "/" }
 
1071
            if (not self.server_settings["debug"]
 
1072
                and self.server_settings["foreground"]):
 
1073
                popen_args.update({"stdout": wnull,
 
1074
                                   "stderr": wnull })
 
1075
            pipe = multiprocessing.Pipe(duplex = False)
 
1076
            self.checker = multiprocessing.Process(
 
1077
                target = call_pipe,
 
1078
                args = (pipe[1], subprocess.call, command),
 
1079
                kwargs = popen_args)
 
1080
            self.checker.start()
 
1081
            self.checker_callback_tag = GLib.io_add_watch(
 
1082
                pipe[0].fileno(), GLib.IO_IN,
 
1083
                self.checker_callback, pipe[0], command)
 
1084
        # Re-run this periodically if run by GLib.timeout_add
763
1085
        return True
764
1086
    
765
1087
    def stop_checker(self):
766
1088
        """Force the checker process, if any, to stop."""
767
1089
        if self.checker_callback_tag:
768
 
            gobject.source_remove(self.checker_callback_tag)
 
1090
            GLib.source_remove(self.checker_callback_tag)
769
1091
            self.checker_callback_tag = None
770
1092
        if getattr(self, "checker", None) is None:
771
1093
            return
772
1094
        logger.debug("Stopping checker for %(name)s", vars(self))
773
 
        try:
774
 
            self.checker.terminate()
775
 
            #time.sleep(0.5)
776
 
            #if self.checker.poll() is None:
777
 
            #    self.checker.kill()
778
 
        except OSError as error:
779
 
            if error.errno != errno.ESRCH: # No such process
780
 
                raise
 
1095
        self.checker.terminate()
781
1096
        self.checker = None
782
1097
 
783
1098
 
784
 
def dbus_service_property(dbus_interface, signature="v",
785
 
                          access="readwrite", byte_arrays=False):
 
1099
def dbus_service_property(dbus_interface,
 
1100
                          signature="v",
 
1101
                          access="readwrite",
 
1102
                          byte_arrays=False):
786
1103
    """Decorators for marking methods of a DBusObjectWithProperties to
787
1104
    become properties on the D-Bus.
788
1105
    
797
1114
    # "Set" method, so we fail early here:
798
1115
    if byte_arrays and signature != "ay":
799
1116
        raise ValueError("Byte arrays not supported for non-'ay'"
800
 
                         " signature {0!r}".format(signature))
 
1117
                         " signature {!r}".format(signature))
 
1118
    
801
1119
    def decorator(func):
802
1120
        func._dbus_is_property = True
803
1121
        func._dbus_interface = dbus_interface
808
1126
            func._dbus_name = func._dbus_name[:-14]
809
1127
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
810
1128
        return func
 
1129
    
811
1130
    return decorator
812
1131
 
813
1132
 
822
1141
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
823
1142
                    "false"}
824
1143
    """
 
1144
    
825
1145
    def decorator(func):
826
1146
        func._dbus_is_interface = True
827
1147
        func._dbus_interface = dbus_interface
828
1148
        func._dbus_name = dbus_interface
829
1149
        return func
 
1150
    
830
1151
    return decorator
831
1152
 
832
1153
 
834
1155
    """Decorator to annotate D-Bus methods, signals or properties
835
1156
    Usage:
836
1157
    
 
1158
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
1159
                       "org.freedesktop.DBus.Property."
 
1160
                       "EmitsChangedSignal": "false"})
837
1161
    @dbus_service_property("org.example.Interface", signature="b",
838
1162
                           access="r")
839
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
840
 
                        "org.freedesktop.DBus.Property."
841
 
                        "EmitsChangedSignal": "false"})
842
1163
    def Property_dbus_property(self):
843
1164
        return dbus.Boolean(False)
 
1165
    
 
1166
    See also the DBusObjectWithAnnotations class.
844
1167
    """
 
1168
    
845
1169
    def decorator(func):
846
1170
        func._dbus_annotations = annotations
847
1171
        return func
 
1172
    
848
1173
    return decorator
849
1174
 
850
1175
 
851
1176
class DBusPropertyException(dbus.exceptions.DBusException):
852
1177
    """A base class for D-Bus property-related exceptions
853
1178
    """
854
 
    def __unicode__(self):
855
 
        return unicode(str(self))
 
1179
    pass
856
1180
 
857
1181
 
858
1182
class DBusPropertyAccessException(DBusPropertyException):
867
1191
    pass
868
1192
 
869
1193
 
870
 
class DBusObjectWithProperties(dbus.service.Object):
871
 
    """A D-Bus object with properties.
 
1194
class DBusObjectWithAnnotations(dbus.service.Object):
 
1195
    """A D-Bus object with annotations.
872
1196
    
873
 
    Classes inheriting from this can use the dbus_service_property
874
 
    decorator to expose methods as D-Bus properties.  It exposes the
875
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1197
    Classes inheriting from this can use the dbus_annotations
 
1198
    decorator to add annotations to methods or signals.
876
1199
    """
877
1200
    
878
1201
    @staticmethod
882
1205
        If called like _is_dbus_thing("method") it returns a function
883
1206
        suitable for use as predicate to inspect.getmembers().
884
1207
        """
885
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
1208
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
886
1209
                                   False)
887
1210
    
888
1211
    def _get_all_dbus_things(self, thing):
889
1212
        """Returns a generator of (name, attribute) pairs
890
1213
        """
891
 
        return ((getattr(athing.__get__(self), "_dbus_name",
892
 
                         name),
 
1214
        return ((getattr(athing.__get__(self), "_dbus_name", name),
893
1215
                 athing.__get__(self))
894
1216
                for cls in self.__class__.__mro__
895
1217
                for name, athing in
896
 
                inspect.getmembers(cls,
897
 
                                   self._is_dbus_thing(thing)))
 
1218
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
1219
    
 
1220
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1221
                         out_signature = "s",
 
1222
                         path_keyword = 'object_path',
 
1223
                         connection_keyword = 'connection')
 
1224
    def Introspect(self, object_path, connection):
 
1225
        """Overloading of standard D-Bus method.
 
1226
        
 
1227
        Inserts annotation tags on methods and signals.
 
1228
        """
 
1229
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1230
                                                   connection)
 
1231
        try:
 
1232
            document = xml.dom.minidom.parseString(xmlstring)
 
1233
            
 
1234
            for if_tag in document.getElementsByTagName("interface"):
 
1235
                # Add annotation tags
 
1236
                for typ in ("method", "signal"):
 
1237
                    for tag in if_tag.getElementsByTagName(typ):
 
1238
                        annots = dict()
 
1239
                        for name, prop in (self.
 
1240
                                           _get_all_dbus_things(typ)):
 
1241
                            if (name == tag.getAttribute("name")
 
1242
                                and prop._dbus_interface
 
1243
                                == if_tag.getAttribute("name")):
 
1244
                                annots.update(getattr(
 
1245
                                    prop, "_dbus_annotations", {}))
 
1246
                        for name, value in annots.items():
 
1247
                            ann_tag = document.createElement(
 
1248
                                "annotation")
 
1249
                            ann_tag.setAttribute("name", name)
 
1250
                            ann_tag.setAttribute("value", value)
 
1251
                            tag.appendChild(ann_tag)
 
1252
                # Add interface annotation tags
 
1253
                for annotation, value in dict(
 
1254
                    itertools.chain.from_iterable(
 
1255
                        annotations().items()
 
1256
                        for name, annotations
 
1257
                        in self._get_all_dbus_things("interface")
 
1258
                        if name == if_tag.getAttribute("name")
 
1259
                        )).items():
 
1260
                    ann_tag = document.createElement("annotation")
 
1261
                    ann_tag.setAttribute("name", annotation)
 
1262
                    ann_tag.setAttribute("value", value)
 
1263
                    if_tag.appendChild(ann_tag)
 
1264
                # Fix argument name for the Introspect method itself
 
1265
                if (if_tag.getAttribute("name")
 
1266
                                == dbus.INTROSPECTABLE_IFACE):
 
1267
                    for cn in if_tag.getElementsByTagName("method"):
 
1268
                        if cn.getAttribute("name") == "Introspect":
 
1269
                            for arg in cn.getElementsByTagName("arg"):
 
1270
                                if (arg.getAttribute("direction")
 
1271
                                    == "out"):
 
1272
                                    arg.setAttribute("name",
 
1273
                                                     "xml_data")
 
1274
            xmlstring = document.toxml("utf-8")
 
1275
            document.unlink()
 
1276
        except (AttributeError, xml.dom.DOMException,
 
1277
                xml.parsers.expat.ExpatError) as error:
 
1278
            logger.error("Failed to override Introspection method",
 
1279
                         exc_info=error)
 
1280
        return xmlstring
 
1281
 
 
1282
 
 
1283
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
1284
    """A D-Bus object with properties.
 
1285
    
 
1286
    Classes inheriting from this can use the dbus_service_property
 
1287
    decorator to expose methods as D-Bus properties.  It exposes the
 
1288
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1289
    """
898
1290
    
899
1291
    def _get_dbus_property(self, interface_name, property_name):
900
1292
        """Returns a bound method if one exists which is a D-Bus
901
1293
        property with the specified name and interface.
902
1294
        """
903
 
        for cls in  self.__class__.__mro__:
904
 
            for name, value in (inspect.getmembers
905
 
                                (cls,
906
 
                                 self._is_dbus_thing("property"))):
 
1295
        for cls in self.__class__.__mro__:
 
1296
            for name, value in inspect.getmembers(
 
1297
                    cls, self._is_dbus_thing("property")):
907
1298
                if (value._dbus_name == property_name
908
1299
                    and value._dbus_interface == interface_name):
909
1300
                    return value.__get__(self)
910
1301
        
911
1302
        # No such property
912
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
913
 
                                   + interface_name + "."
914
 
                                   + property_name)
915
 
    
916
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
1303
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
1304
            self.dbus_object_path, interface_name, property_name))
 
1305
    
 
1306
    @classmethod
 
1307
    def _get_all_interface_names(cls):
 
1308
        """Get a sequence of all interfaces supported by an object"""
 
1309
        return (name for name in set(getattr(getattr(x, attr),
 
1310
                                             "_dbus_interface", None)
 
1311
                                     for x in (inspect.getmro(cls))
 
1312
                                     for attr in dir(x))
 
1313
                if name is not None)
 
1314
    
 
1315
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1316
                         in_signature="ss",
917
1317
                         out_signature="v")
918
1318
    def Get(self, interface_name, property_name):
919
1319
        """Standard D-Bus property Get() method, see D-Bus standard.
938
1338
            # signatures other than "ay".
939
1339
            if prop._dbus_signature != "ay":
940
1340
                raise ValueError("Byte arrays not supported for non-"
941
 
                                 "'ay' signature {0!r}"
 
1341
                                 "'ay' signature {!r}"
942
1342
                                 .format(prop._dbus_signature))
943
1343
            value = dbus.ByteArray(b''.join(chr(byte)
944
1344
                                            for byte in value))
945
1345
        prop(value)
946
1346
    
947
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1347
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1348
                         in_signature="s",
948
1349
                         out_signature="a{sv}")
949
1350
    def GetAll(self, interface_name):
950
1351
        """Standard D-Bus property GetAll() method, see D-Bus
965
1366
            if not hasattr(value, "variant_level"):
966
1367
                properties[name] = value
967
1368
                continue
968
 
            properties[name] = type(value)(value, variant_level=
969
 
                                           value.variant_level+1)
 
1369
            properties[name] = type(value)(
 
1370
                value, variant_level = value.variant_level + 1)
970
1371
        return dbus.Dictionary(properties, signature="sv")
971
1372
    
 
1373
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1374
    def PropertiesChanged(self, interface_name, changed_properties,
 
1375
                          invalidated_properties):
 
1376
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1377
        standard.
 
1378
        """
 
1379
        pass
 
1380
    
972
1381
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
973
1382
                         out_signature="s",
974
1383
                         path_keyword='object_path',
978
1387
        
979
1388
        Inserts property tags and interface annotation tags.
980
1389
        """
981
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
982
 
                                                   connection)
 
1390
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1391
                                                         object_path,
 
1392
                                                         connection)
983
1393
        try:
984
1394
            document = xml.dom.minidom.parseString(xmlstring)
 
1395
            
985
1396
            def make_tag(document, name, prop):
986
1397
                e = document.createElement("property")
987
1398
                e.setAttribute("name", name)
988
1399
                e.setAttribute("type", prop._dbus_signature)
989
1400
                e.setAttribute("access", prop._dbus_access)
990
1401
                return e
 
1402
            
991
1403
            for if_tag in document.getElementsByTagName("interface"):
992
1404
                # Add property tags
993
1405
                for tag in (make_tag(document, name, prop)
996
1408
                            if prop._dbus_interface
997
1409
                            == if_tag.getAttribute("name")):
998
1410
                    if_tag.appendChild(tag)
999
 
                # Add annotation tags
1000
 
                for typ in ("method", "signal", "property"):
1001
 
                    for tag in if_tag.getElementsByTagName(typ):
1002
 
                        annots = dict()
1003
 
                        for name, prop in (self.
1004
 
                                           _get_all_dbus_things(typ)):
1005
 
                            if (name == tag.getAttribute("name")
1006
 
                                and prop._dbus_interface
1007
 
                                == if_tag.getAttribute("name")):
1008
 
                                annots.update(getattr
1009
 
                                              (prop,
1010
 
                                               "_dbus_annotations",
1011
 
                                               {}))
1012
 
                        for name, value in annots.iteritems():
1013
 
                            ann_tag = document.createElement(
1014
 
                                "annotation")
1015
 
                            ann_tag.setAttribute("name", name)
1016
 
                            ann_tag.setAttribute("value", value)
1017
 
                            tag.appendChild(ann_tag)
1018
 
                # Add interface annotation tags
1019
 
                for annotation, value in dict(
1020
 
                    itertools.chain.from_iterable(
1021
 
                        annotations().iteritems()
1022
 
                        for name, annotations in
1023
 
                        self._get_all_dbus_things("interface")
1024
 
                        if name == if_tag.getAttribute("name")
1025
 
                        )).iteritems():
1026
 
                    ann_tag = document.createElement("annotation")
1027
 
                    ann_tag.setAttribute("name", annotation)
1028
 
                    ann_tag.setAttribute("value", value)
1029
 
                    if_tag.appendChild(ann_tag)
 
1411
                # Add annotation tags for properties
 
1412
                for tag in if_tag.getElementsByTagName("property"):
 
1413
                    annots = dict()
 
1414
                    for name, prop in self._get_all_dbus_things(
 
1415
                            "property"):
 
1416
                        if (name == tag.getAttribute("name")
 
1417
                            and prop._dbus_interface
 
1418
                            == if_tag.getAttribute("name")):
 
1419
                            annots.update(getattr(
 
1420
                                prop, "_dbus_annotations", {}))
 
1421
                    for name, value in annots.items():
 
1422
                        ann_tag = document.createElement(
 
1423
                            "annotation")
 
1424
                        ann_tag.setAttribute("name", name)
 
1425
                        ann_tag.setAttribute("value", value)
 
1426
                        tag.appendChild(ann_tag)
1030
1427
                # Add the names to the return values for the
1031
1428
                # "org.freedesktop.DBus.Properties" methods
1032
1429
                if (if_tag.getAttribute("name")
1050
1447
                         exc_info=error)
1051
1448
        return xmlstring
1052
1449
 
 
1450
try:
 
1451
    dbus.OBJECT_MANAGER_IFACE
 
1452
except AttributeError:
 
1453
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1454
 
 
1455
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1456
    """A D-Bus object with an ObjectManager.
 
1457
    
 
1458
    Classes inheriting from this exposes the standard
 
1459
    GetManagedObjects call and the InterfacesAdded and
 
1460
    InterfacesRemoved signals on the standard
 
1461
    "org.freedesktop.DBus.ObjectManager" interface.
 
1462
    
 
1463
    Note: No signals are sent automatically; they must be sent
 
1464
    manually.
 
1465
    """
 
1466
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1467
                         out_signature = "a{oa{sa{sv}}}")
 
1468
    def GetManagedObjects(self):
 
1469
        """This function must be overridden"""
 
1470
        raise NotImplementedError()
 
1471
    
 
1472
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1473
                         signature = "oa{sa{sv}}")
 
1474
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1475
        pass
 
1476
    
 
1477
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1478
    def InterfacesRemoved(self, object_path, interfaces):
 
1479
        pass
 
1480
    
 
1481
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1482
                         out_signature = "s",
 
1483
                         path_keyword = 'object_path',
 
1484
                         connection_keyword = 'connection')
 
1485
    def Introspect(self, object_path, connection):
 
1486
        """Overloading of standard D-Bus method.
 
1487
        
 
1488
        Override return argument name of GetManagedObjects to be
 
1489
        "objpath_interfaces_and_properties"
 
1490
        """
 
1491
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1492
                                                         object_path,
 
1493
                                                         connection)
 
1494
        try:
 
1495
            document = xml.dom.minidom.parseString(xmlstring)
 
1496
            
 
1497
            for if_tag in document.getElementsByTagName("interface"):
 
1498
                # Fix argument name for the GetManagedObjects method
 
1499
                if (if_tag.getAttribute("name")
 
1500
                                == dbus.OBJECT_MANAGER_IFACE):
 
1501
                    for cn in if_tag.getElementsByTagName("method"):
 
1502
                        if (cn.getAttribute("name")
 
1503
                            == "GetManagedObjects"):
 
1504
                            for arg in cn.getElementsByTagName("arg"):
 
1505
                                if (arg.getAttribute("direction")
 
1506
                                    == "out"):
 
1507
                                    arg.setAttribute(
 
1508
                                        "name",
 
1509
                                        "objpath_interfaces"
 
1510
                                        "_and_properties")
 
1511
            xmlstring = document.toxml("utf-8")
 
1512
            document.unlink()
 
1513
        except (AttributeError, xml.dom.DOMException,
 
1514
                xml.parsers.expat.ExpatError) as error:
 
1515
            logger.error("Failed to override Introspection method",
 
1516
                         exc_info = error)
 
1517
        return xmlstring
1053
1518
 
1054
1519
def datetime_to_dbus(dt, variant_level=0):
1055
1520
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1056
1521
    if dt is None:
1057
1522
        return dbus.String("", variant_level = variant_level)
1058
 
    return dbus.String(dt.isoformat(),
1059
 
                       variant_level=variant_level)
 
1523
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1060
1524
 
1061
1525
 
1062
1526
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1082
1546
    (from DBusObjectWithProperties) and interfaces (from the
1083
1547
    dbus_interface_annotations decorator).
1084
1548
    """
 
1549
    
1085
1550
    def wrapper(cls):
1086
1551
        for orig_interface_name, alt_interface_name in (
1087
 
            alt_interface_names.iteritems()):
 
1552
                alt_interface_names.items()):
1088
1553
            attr = {}
1089
1554
            interface_names = set()
1090
1555
            # Go though all attributes of the class
1092
1557
                # Ignore non-D-Bus attributes, and D-Bus attributes
1093
1558
                # with the wrong interface name
1094
1559
                if (not hasattr(attribute, "_dbus_interface")
1095
 
                    or not attribute._dbus_interface
1096
 
                    .startswith(orig_interface_name)):
 
1560
                    or not attribute._dbus_interface.startswith(
 
1561
                        orig_interface_name)):
1097
1562
                    continue
1098
1563
                # Create an alternate D-Bus interface name based on
1099
1564
                # the current name
1100
 
                alt_interface = (attribute._dbus_interface
1101
 
                                 .replace(orig_interface_name,
1102
 
                                          alt_interface_name))
 
1565
                alt_interface = attribute._dbus_interface.replace(
 
1566
                    orig_interface_name, alt_interface_name)
1103
1567
                interface_names.add(alt_interface)
1104
1568
                # Is this a D-Bus signal?
1105
1569
                if getattr(attribute, "_dbus_is_signal", False):
1106
1570
                    # Extract the original non-method undecorated
1107
1571
                    # function by black magic
1108
 
                    nonmethod_func = (dict(
 
1572
                    if sys.version_info.major == 2:
 
1573
                        nonmethod_func = (dict(
1109
1574
                            zip(attribute.func_code.co_freevars,
1110
 
                                attribute.__closure__))["func"]
1111
 
                                      .cell_contents)
 
1575
                                attribute.__closure__))
 
1576
                                          ["func"].cell_contents)
 
1577
                    else:
 
1578
                        nonmethod_func = (dict(
 
1579
                            zip(attribute.__code__.co_freevars,
 
1580
                                attribute.__closure__))
 
1581
                                          ["func"].cell_contents)
1112
1582
                    # Create a new, but exactly alike, function
1113
1583
                    # object, and decorate it to be a new D-Bus signal
1114
1584
                    # with the alternate D-Bus interface name
1115
 
                    new_function = (dbus.service.signal
1116
 
                                    (alt_interface,
1117
 
                                     attribute._dbus_signature)
1118
 
                                    (types.FunctionType(
1119
 
                                nonmethod_func.func_code,
1120
 
                                nonmethod_func.func_globals,
1121
 
                                nonmethod_func.func_name,
1122
 
                                nonmethod_func.func_defaults,
1123
 
                                nonmethod_func.func_closure)))
 
1585
                    new_function = copy_function(nonmethod_func)
 
1586
                    new_function = (dbus.service.signal(
 
1587
                        alt_interface,
 
1588
                        attribute._dbus_signature)(new_function))
1124
1589
                    # Copy annotations, if any
1125
1590
                    try:
1126
 
                        new_function._dbus_annotations = (
1127
 
                            dict(attribute._dbus_annotations))
 
1591
                        new_function._dbus_annotations = dict(
 
1592
                            attribute._dbus_annotations)
1128
1593
                    except AttributeError:
1129
1594
                        pass
1130
1595
                    # Define a creator of a function to call both the
1135
1600
                        """This function is a scope container to pass
1136
1601
                        func1 and func2 to the "call_both" function
1137
1602
                        outside of its arguments"""
 
1603
                        
 
1604
                        @functools.wraps(func2)
1138
1605
                        def call_both(*args, **kwargs):
1139
1606
                            """This function will emit two D-Bus
1140
1607
                            signals by calling func1 and func2"""
1141
1608
                            func1(*args, **kwargs)
1142
1609
                            func2(*args, **kwargs)
 
1610
                        # Make wrapper function look like a D-Bus signal
 
1611
                        for name, attr in inspect.getmembers(func2):
 
1612
                            if name.startswith("_dbus_"):
 
1613
                                setattr(call_both, name, attr)
 
1614
                        
1143
1615
                        return call_both
1144
1616
                    # Create the "call_both" function and add it to
1145
1617
                    # the class
1150
1622
                    # object.  Decorate it to be a new D-Bus method
1151
1623
                    # with the alternate D-Bus interface name.  Add it
1152
1624
                    # to the class.
1153
 
                    attr[attrname] = (dbus.service.method
1154
 
                                      (alt_interface,
1155
 
                                       attribute._dbus_in_signature,
1156
 
                                       attribute._dbus_out_signature)
1157
 
                                      (types.FunctionType
1158
 
                                       (attribute.func_code,
1159
 
                                        attribute.func_globals,
1160
 
                                        attribute.func_name,
1161
 
                                        attribute.func_defaults,
1162
 
                                        attribute.func_closure)))
 
1625
                    attr[attrname] = (
 
1626
                        dbus.service.method(
 
1627
                            alt_interface,
 
1628
                            attribute._dbus_in_signature,
 
1629
                            attribute._dbus_out_signature)
 
1630
                        (copy_function(attribute)))
1163
1631
                    # Copy annotations, if any
1164
1632
                    try:
1165
 
                        attr[attrname]._dbus_annotations = (
1166
 
                            dict(attribute._dbus_annotations))
 
1633
                        attr[attrname]._dbus_annotations = dict(
 
1634
                            attribute._dbus_annotations)
1167
1635
                    except AttributeError:
1168
1636
                        pass
1169
1637
                # Is this a D-Bus property?
1172
1640
                    # object, and decorate it to be a new D-Bus
1173
1641
                    # property with the alternate D-Bus interface
1174
1642
                    # name.  Add it to the class.
1175
 
                    attr[attrname] = (dbus_service_property
1176
 
                                      (alt_interface,
1177
 
                                       attribute._dbus_signature,
1178
 
                                       attribute._dbus_access,
1179
 
                                       attribute
1180
 
                                       ._dbus_get_args_options
1181
 
                                       ["byte_arrays"])
1182
 
                                      (types.FunctionType
1183
 
                                       (attribute.func_code,
1184
 
                                        attribute.func_globals,
1185
 
                                        attribute.func_name,
1186
 
                                        attribute.func_defaults,
1187
 
                                        attribute.func_closure)))
 
1643
                    attr[attrname] = (dbus_service_property(
 
1644
                        alt_interface, attribute._dbus_signature,
 
1645
                        attribute._dbus_access,
 
1646
                        attribute._dbus_get_args_options
 
1647
                        ["byte_arrays"])
 
1648
                                      (copy_function(attribute)))
1188
1649
                    # Copy annotations, if any
1189
1650
                    try:
1190
 
                        attr[attrname]._dbus_annotations = (
1191
 
                            dict(attribute._dbus_annotations))
 
1651
                        attr[attrname]._dbus_annotations = dict(
 
1652
                            attribute._dbus_annotations)
1192
1653
                    except AttributeError:
1193
1654
                        pass
1194
1655
                # Is this a D-Bus interface?
1197
1658
                    # object.  Decorate it to be a new D-Bus interface
1198
1659
                    # with the alternate D-Bus interface name.  Add it
1199
1660
                    # to the class.
1200
 
                    attr[attrname] = (dbus_interface_annotations
1201
 
                                      (alt_interface)
1202
 
                                      (types.FunctionType
1203
 
                                       (attribute.func_code,
1204
 
                                        attribute.func_globals,
1205
 
                                        attribute.func_name,
1206
 
                                        attribute.func_defaults,
1207
 
                                        attribute.func_closure)))
 
1661
                    attr[attrname] = (
 
1662
                        dbus_interface_annotations(alt_interface)
 
1663
                        (copy_function(attribute)))
1208
1664
            if deprecate:
1209
1665
                # Deprecate all alternate interfaces
1210
 
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1666
                iname="_AlternateDBusNames_interface_annotation{}"
1211
1667
                for interface_name in interface_names:
 
1668
                    
1212
1669
                    @dbus_interface_annotations(interface_name)
1213
1670
                    def func(self):
1214
1671
                        return { "org.freedesktop.DBus.Deprecated":
1215
 
                                     "true" }
 
1672
                                 "true" }
1216
1673
                    # Find an unused name
1217
1674
                    for aname in (iname.format(i)
1218
1675
                                  for i in itertools.count()):
1222
1679
            if interface_names:
1223
1680
                # Replace the class with a new subclass of it with
1224
1681
                # methods, signals, etc. as created above.
1225
 
                cls = type(b"{0}Alternate".format(cls.__name__),
1226
 
                           (cls,), attr)
 
1682
                if sys.version_info.major == 2:
 
1683
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1684
                               (cls, ), attr)
 
1685
                else:
 
1686
                    cls = type("{}Alternate".format(cls.__name__),
 
1687
                               (cls, ), attr)
1227
1688
        return cls
 
1689
    
1228
1690
    return wrapper
1229
1691
 
1230
1692
 
1231
1693
@alternate_dbus_interfaces({"se.recompile.Mandos":
1232
 
                                "se.bsnet.fukt.Mandos"})
 
1694
                            "se.bsnet.fukt.Mandos"})
1233
1695
class ClientDBus(Client, DBusObjectWithProperties):
1234
1696
    """A Client class using D-Bus
1235
1697
    
1239
1701
    """
1240
1702
    
1241
1703
    runtime_expansions = (Client.runtime_expansions
1242
 
                          + ("dbus_object_path",))
 
1704
                          + ("dbus_object_path", ))
 
1705
    
 
1706
    _interface = "se.recompile.Mandos.Client"
1243
1707
    
1244
1708
    # dbus.service.Object doesn't use super(), so we can't either.
1245
1709
    
1248
1712
        Client.__init__(self, *args, **kwargs)
1249
1713
        # Only now, when this client is initialized, can it show up on
1250
1714
        # the D-Bus
1251
 
        client_object_name = unicode(self.name).translate(
 
1715
        client_object_name = str(self.name).translate(
1252
1716
            {ord("."): ord("_"),
1253
1717
             ord("-"): ord("_")})
1254
 
        self.dbus_object_path = (dbus.ObjectPath
1255
 
                                 ("/clients/" + client_object_name))
 
1718
        self.dbus_object_path = dbus.ObjectPath(
 
1719
            "/clients/" + client_object_name)
1256
1720
        DBusObjectWithProperties.__init__(self, self.bus,
1257
1721
                                          self.dbus_object_path)
1258
1722
    
1259
 
    def notifychangeproperty(transform_func,
1260
 
                             dbus_name, type_func=lambda x: x,
1261
 
                             variant_level=1):
 
1723
    def notifychangeproperty(transform_func, dbus_name,
 
1724
                             type_func=lambda x: x,
 
1725
                             variant_level=1,
 
1726
                             invalidate_only=False,
 
1727
                             _interface=_interface):
1262
1728
        """ Modify a variable so that it's a property which announces
1263
1729
        its changes to DBus.
1264
1730
        
1269
1735
                   to the D-Bus.  Default: no transform
1270
1736
        variant_level: D-Bus variant level.  Default: 1
1271
1737
        """
1272
 
        attrname = "_{0}".format(dbus_name)
 
1738
        attrname = "_{}".format(dbus_name)
 
1739
        
1273
1740
        def setter(self, value):
1274
1741
            if hasattr(self, "dbus_object_path"):
1275
1742
                if (not hasattr(self, attrname) or
1276
1743
                    type_func(getattr(self, attrname, None))
1277
1744
                    != type_func(value)):
1278
 
                    dbus_value = transform_func(type_func(value),
1279
 
                                                variant_level
1280
 
                                                =variant_level)
1281
 
                    self.PropertyChanged(dbus.String(dbus_name),
1282
 
                                         dbus_value)
 
1745
                    if invalidate_only:
 
1746
                        self.PropertiesChanged(
 
1747
                            _interface, dbus.Dictionary(),
 
1748
                            dbus.Array((dbus_name, )))
 
1749
                    else:
 
1750
                        dbus_value = transform_func(
 
1751
                            type_func(value),
 
1752
                            variant_level = variant_level)
 
1753
                        self.PropertyChanged(dbus.String(dbus_name),
 
1754
                                             dbus_value)
 
1755
                        self.PropertiesChanged(
 
1756
                            _interface,
 
1757
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1758
                                              dbus_value }),
 
1759
                            dbus.Array())
1283
1760
            setattr(self, attrname, value)
1284
1761
        
1285
1762
        return property(lambda self: getattr(self, attrname), setter)
1291
1768
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1292
1769
    last_enabled = notifychangeproperty(datetime_to_dbus,
1293
1770
                                        "LastEnabled")
1294
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1295
 
                                   type_func = lambda checker:
1296
 
                                       checker is not None)
 
1771
    checker = notifychangeproperty(
 
1772
        dbus.Boolean, "CheckerRunning",
 
1773
        type_func = lambda checker: checker is not None)
1297
1774
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1298
1775
                                           "LastCheckedOK")
1299
1776
    last_checker_status = notifychangeproperty(dbus.Int16,
1302
1779
        datetime_to_dbus, "LastApprovalRequest")
1303
1780
    approved_by_default = notifychangeproperty(dbus.Boolean,
1304
1781
                                               "ApprovedByDefault")
1305
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1306
 
                                          "ApprovalDelay",
1307
 
                                          type_func =
1308
 
                                          timedelta_to_milliseconds)
 
1782
    approval_delay = notifychangeproperty(
 
1783
        dbus.UInt64, "ApprovalDelay",
 
1784
        type_func = lambda td: td.total_seconds() * 1000)
1309
1785
    approval_duration = notifychangeproperty(
1310
1786
        dbus.UInt64, "ApprovalDuration",
1311
 
        type_func = timedelta_to_milliseconds)
 
1787
        type_func = lambda td: td.total_seconds() * 1000)
1312
1788
    host = notifychangeproperty(dbus.String, "Host")
1313
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1314
 
                                   type_func =
1315
 
                                   timedelta_to_milliseconds)
 
1789
    timeout = notifychangeproperty(
 
1790
        dbus.UInt64, "Timeout",
 
1791
        type_func = lambda td: td.total_seconds() * 1000)
1316
1792
    extended_timeout = notifychangeproperty(
1317
1793
        dbus.UInt64, "ExtendedTimeout",
1318
 
        type_func = timedelta_to_milliseconds)
1319
 
    interval = notifychangeproperty(dbus.UInt64,
1320
 
                                    "Interval",
1321
 
                                    type_func =
1322
 
                                    timedelta_to_milliseconds)
 
1794
        type_func = lambda td: td.total_seconds() * 1000)
 
1795
    interval = notifychangeproperty(
 
1796
        dbus.UInt64, "Interval",
 
1797
        type_func = lambda td: td.total_seconds() * 1000)
1323
1798
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1799
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1800
                                  invalidate_only=True)
1324
1801
    
1325
1802
    del notifychangeproperty
1326
1803
    
1333
1810
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1334
1811
        Client.__del__(self, *args, **kwargs)
1335
1812
    
1336
 
    def checker_callback(self, pid, condition, command,
1337
 
                         *args, **kwargs):
1338
 
        self.checker_callback_tag = None
1339
 
        self.checker = None
1340
 
        if os.WIFEXITED(condition):
1341
 
            exitstatus = os.WEXITSTATUS(condition)
 
1813
    def checker_callback(self, source, condition,
 
1814
                         connection, command, *args, **kwargs):
 
1815
        ret = Client.checker_callback(self, source, condition,
 
1816
                                      connection, command, *args,
 
1817
                                      **kwargs)
 
1818
        exitstatus = self.last_checker_status
 
1819
        if exitstatus >= 0:
1342
1820
            # Emit D-Bus signal
1343
1821
            self.CheckerCompleted(dbus.Int16(exitstatus),
1344
 
                                  dbus.Int64(condition),
 
1822
                                  # This is specific to GNU libC
 
1823
                                  dbus.Int64(exitstatus << 8),
1345
1824
                                  dbus.String(command))
1346
1825
        else:
1347
1826
            # Emit D-Bus signal
1348
1827
            self.CheckerCompleted(dbus.Int16(-1),
1349
 
                                  dbus.Int64(condition),
 
1828
                                  dbus.Int64(
 
1829
                                      # This is specific to GNU libC
 
1830
                                      (exitstatus << 8)
 
1831
                                      | self.last_checker_signal),
1350
1832
                                  dbus.String(command))
1351
 
        
1352
 
        return Client.checker_callback(self, pid, condition, command,
1353
 
                                       *args, **kwargs)
 
1833
        return ret
1354
1834
    
1355
1835
    def start_checker(self, *args, **kwargs):
1356
1836
        old_checker_pid = getattr(self.checker, "pid", None)
1368
1848
    
1369
1849
    def approve(self, value=True):
1370
1850
        self.approved = value
1371
 
        gobject.timeout_add(timedelta_to_milliseconds
1372
 
                            (self.approval_duration),
1373
 
                            self._reset_approved)
 
1851
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1852
                             * 1000), self._reset_approved)
1374
1853
        self.send_changedstate()
1375
1854
    
1376
1855
    ## D-Bus methods, signals & properties
1377
 
    _interface = "se.recompile.Mandos.Client"
1378
1856
    
1379
1857
    ## Interfaces
1380
1858
    
1381
 
    @dbus_interface_annotations(_interface)
1382
 
    def _foo(self):
1383
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1384
 
                     "false"}
1385
 
    
1386
1859
    ## Signals
1387
1860
    
1388
1861
    # CheckerCompleted - signal
1398
1871
        pass
1399
1872
    
1400
1873
    # PropertyChanged - signal
 
1874
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1401
1875
    @dbus.service.signal(_interface, signature="sv")
1402
1876
    def PropertyChanged(self, property, value):
1403
1877
        "D-Bus signal"
1437
1911
        self.checked_ok()
1438
1912
    
1439
1913
    # Enable - method
 
1914
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1440
1915
    @dbus.service.method(_interface)
1441
1916
    def Enable(self):
1442
1917
        "D-Bus method"
1443
1918
        self.enable()
1444
1919
    
1445
1920
    # StartChecker - method
 
1921
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1446
1922
    @dbus.service.method(_interface)
1447
1923
    def StartChecker(self):
1448
1924
        "D-Bus method"
1449
1925
        self.start_checker()
1450
1926
    
1451
1927
    # Disable - method
 
1928
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1452
1929
    @dbus.service.method(_interface)
1453
1930
    def Disable(self):
1454
1931
        "D-Bus method"
1455
1932
        self.disable()
1456
1933
    
1457
1934
    # StopChecker - method
 
1935
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1458
1936
    @dbus.service.method(_interface)
1459
1937
    def StopChecker(self):
1460
1938
        self.stop_checker()
1467
1945
        return dbus.Boolean(bool(self.approvals_pending))
1468
1946
    
1469
1947
    # ApprovedByDefault - property
1470
 
    @dbus_service_property(_interface, signature="b",
 
1948
    @dbus_service_property(_interface,
 
1949
                           signature="b",
1471
1950
                           access="readwrite")
1472
1951
    def ApprovedByDefault_dbus_property(self, value=None):
1473
1952
        if value is None:       # get
1475
1954
        self.approved_by_default = bool(value)
1476
1955
    
1477
1956
    # ApprovalDelay - property
1478
 
    @dbus_service_property(_interface, signature="t",
 
1957
    @dbus_service_property(_interface,
 
1958
                           signature="t",
1479
1959
                           access="readwrite")
1480
1960
    def ApprovalDelay_dbus_property(self, value=None):
1481
1961
        if value is None:       # get
1482
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1962
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1963
                               * 1000)
1483
1964
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1484
1965
    
1485
1966
    # ApprovalDuration - property
1486
 
    @dbus_service_property(_interface, signature="t",
 
1967
    @dbus_service_property(_interface,
 
1968
                           signature="t",
1487
1969
                           access="readwrite")
1488
1970
    def ApprovalDuration_dbus_property(self, value=None):
1489
1971
        if value is None:       # get
1490
 
            return dbus.UInt64(timedelta_to_milliseconds(
1491
 
                    self.approval_duration))
 
1972
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1973
                               * 1000)
1492
1974
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1493
1975
    
1494
1976
    # Name - property
 
1977
    @dbus_annotations(
 
1978
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1495
1979
    @dbus_service_property(_interface, signature="s", access="read")
1496
1980
    def Name_dbus_property(self):
1497
1981
        return dbus.String(self.name)
1498
1982
    
1499
1983
    # Fingerprint - property
 
1984
    @dbus_annotations(
 
1985
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1500
1986
    @dbus_service_property(_interface, signature="s", access="read")
1501
1987
    def Fingerprint_dbus_property(self):
1502
1988
        return dbus.String(self.fingerprint)
1503
1989
    
1504
1990
    # Host - property
1505
 
    @dbus_service_property(_interface, signature="s",
 
1991
    @dbus_service_property(_interface,
 
1992
                           signature="s",
1506
1993
                           access="readwrite")
1507
1994
    def Host_dbus_property(self, value=None):
1508
1995
        if value is None:       # get
1509
1996
            return dbus.String(self.host)
1510
 
        self.host = unicode(value)
 
1997
        self.host = str(value)
1511
1998
    
1512
1999
    # Created - property
 
2000
    @dbus_annotations(
 
2001
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1513
2002
    @dbus_service_property(_interface, signature="s", access="read")
1514
2003
    def Created_dbus_property(self):
1515
2004
        return datetime_to_dbus(self.created)
1520
2009
        return datetime_to_dbus(self.last_enabled)
1521
2010
    
1522
2011
    # Enabled - property
1523
 
    @dbus_service_property(_interface, signature="b",
 
2012
    @dbus_service_property(_interface,
 
2013
                           signature="b",
1524
2014
                           access="readwrite")
1525
2015
    def Enabled_dbus_property(self, value=None):
1526
2016
        if value is None:       # get
1531
2021
            self.disable()
1532
2022
    
1533
2023
    # LastCheckedOK - property
1534
 
    @dbus_service_property(_interface, signature="s",
 
2024
    @dbus_service_property(_interface,
 
2025
                           signature="s",
1535
2026
                           access="readwrite")
1536
2027
    def LastCheckedOK_dbus_property(self, value=None):
1537
2028
        if value is not None:
1540
2031
        return datetime_to_dbus(self.last_checked_ok)
1541
2032
    
1542
2033
    # LastCheckerStatus - property
1543
 
    @dbus_service_property(_interface, signature="n",
1544
 
                           access="read")
 
2034
    @dbus_service_property(_interface, signature="n", access="read")
1545
2035
    def LastCheckerStatus_dbus_property(self):
1546
2036
        return dbus.Int16(self.last_checker_status)
1547
2037
    
1556
2046
        return datetime_to_dbus(self.last_approval_request)
1557
2047
    
1558
2048
    # Timeout - property
1559
 
    @dbus_service_property(_interface, signature="t",
 
2049
    @dbus_service_property(_interface,
 
2050
                           signature="t",
1560
2051
                           access="readwrite")
1561
2052
    def Timeout_dbus_property(self, value=None):
1562
2053
        if value is None:       # get
1563
 
            return dbus.UInt64(self.timeout_milliseconds())
 
2054
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1564
2055
        old_timeout = self.timeout
1565
2056
        self.timeout = datetime.timedelta(0, 0, 0, value)
1566
2057
        # Reschedule disabling
1574
2065
                if (getattr(self, "disable_initiator_tag", None)
1575
2066
                    is None):
1576
2067
                    return
1577
 
                gobject.source_remove(self.disable_initiator_tag)
1578
 
                self.disable_initiator_tag = (
1579
 
                    gobject.timeout_add(
1580
 
                        timedelta_to_milliseconds(self.expires - now),
1581
 
                        self.disable))
 
2068
                GLib.source_remove(self.disable_initiator_tag)
 
2069
                self.disable_initiator_tag = GLib.timeout_add(
 
2070
                    int((self.expires - now).total_seconds() * 1000),
 
2071
                    self.disable)
1582
2072
    
1583
2073
    # ExtendedTimeout - property
1584
 
    @dbus_service_property(_interface, signature="t",
 
2074
    @dbus_service_property(_interface,
 
2075
                           signature="t",
1585
2076
                           access="readwrite")
1586
2077
    def ExtendedTimeout_dbus_property(self, value=None):
1587
2078
        if value is None:       # get
1588
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
2079
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
2080
                               * 1000)
1589
2081
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1590
2082
    
1591
2083
    # Interval - property
1592
 
    @dbus_service_property(_interface, signature="t",
 
2084
    @dbus_service_property(_interface,
 
2085
                           signature="t",
1593
2086
                           access="readwrite")
1594
2087
    def Interval_dbus_property(self, value=None):
1595
2088
        if value is None:       # get
1596
 
            return dbus.UInt64(self.interval_milliseconds())
 
2089
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1597
2090
        self.interval = datetime.timedelta(0, 0, 0, value)
1598
2091
        if getattr(self, "checker_initiator_tag", None) is None:
1599
2092
            return
1600
2093
        if self.enabled:
1601
2094
            # Reschedule checker run
1602
 
            gobject.source_remove(self.checker_initiator_tag)
1603
 
            self.checker_initiator_tag = (gobject.timeout_add
1604
 
                                          (value, self.start_checker))
1605
 
            self.start_checker()    # Start one now, too
 
2095
            GLib.source_remove(self.checker_initiator_tag)
 
2096
            self.checker_initiator_tag = GLib.timeout_add(
 
2097
                value, self.start_checker)
 
2098
            self.start_checker() # Start one now, too
1606
2099
    
1607
2100
    # Checker - property
1608
 
    @dbus_service_property(_interface, signature="s",
 
2101
    @dbus_service_property(_interface,
 
2102
                           signature="s",
1609
2103
                           access="readwrite")
1610
2104
    def Checker_dbus_property(self, value=None):
1611
2105
        if value is None:       # get
1612
2106
            return dbus.String(self.checker_command)
1613
 
        self.checker_command = unicode(value)
 
2107
        self.checker_command = str(value)
1614
2108
    
1615
2109
    # CheckerRunning - property
1616
 
    @dbus_service_property(_interface, signature="b",
 
2110
    @dbus_service_property(_interface,
 
2111
                           signature="b",
1617
2112
                           access="readwrite")
1618
2113
    def CheckerRunning_dbus_property(self, value=None):
1619
2114
        if value is None:       # get
1624
2119
            self.stop_checker()
1625
2120
    
1626
2121
    # ObjectPath - property
 
2122
    @dbus_annotations(
 
2123
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2124
         "org.freedesktop.DBus.Deprecated": "true"})
1627
2125
    @dbus_service_property(_interface, signature="o", access="read")
1628
2126
    def ObjectPath_dbus_property(self):
1629
2127
        return self.dbus_object_path # is already a dbus.ObjectPath
1630
2128
    
1631
2129
    # Secret = property
1632
 
    @dbus_service_property(_interface, signature="ay",
1633
 
                           access="write", byte_arrays=True)
 
2130
    @dbus_annotations(
 
2131
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2132
         "invalidates"})
 
2133
    @dbus_service_property(_interface,
 
2134
                           signature="ay",
 
2135
                           access="write",
 
2136
                           byte_arrays=True)
1634
2137
    def Secret_dbus_property(self, value):
1635
 
        self.secret = str(value)
 
2138
        self.secret = bytes(value)
1636
2139
    
1637
2140
    del _interface
1638
2141
 
1642
2145
        self._pipe = child_pipe
1643
2146
        self._pipe.send(('init', fpr, address))
1644
2147
        if not self._pipe.recv():
1645
 
            raise KeyError()
 
2148
            raise KeyError(fpr)
1646
2149
    
1647
2150
    def __getattribute__(self, name):
1648
2151
        if name == '_pipe':
1652
2155
        if data[0] == 'data':
1653
2156
            return data[1]
1654
2157
        if data[0] == 'function':
 
2158
            
1655
2159
            def func(*args, **kwargs):
1656
2160
                self._pipe.send(('funcall', name, args, kwargs))
1657
2161
                return self._pipe.recv()[1]
 
2162
            
1658
2163
            return func
1659
2164
    
1660
2165
    def __setattr__(self, name, value):
1672
2177
    def handle(self):
1673
2178
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1674
2179
            logger.info("TCP connection from: %s",
1675
 
                        unicode(self.client_address))
 
2180
                        str(self.client_address))
1676
2181
            logger.debug("Pipe FD: %d",
1677
2182
                         self.server.child_pipe.fileno())
1678
2183
            
1679
 
            session = (gnutls.connection
1680
 
                       .ClientSession(self.request,
1681
 
                                      gnutls.connection
1682
 
                                      .X509Credentials()))
1683
 
            
1684
 
            # Note: gnutls.connection.X509Credentials is really a
1685
 
            # generic GnuTLS certificate credentials object so long as
1686
 
            # no X.509 keys are added to it.  Therefore, we can use it
1687
 
            # here despite using OpenPGP certificates.
 
2184
            session = gnutls.ClientSession(self.request)
1688
2185
            
1689
2186
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1690
2187
            #                      "+AES-256-CBC", "+SHA1",
1694
2191
            priority = self.server.gnutls_priority
1695
2192
            if priority is None:
1696
2193
                priority = "NORMAL"
1697
 
            (gnutls.library.functions
1698
 
             .gnutls_priority_set_direct(session._c_object,
1699
 
                                         priority, None))
 
2194
            gnutls.priority_set_direct(session._c_object,
 
2195
                                       priority.encode("utf-8"),
 
2196
                                       None)
1700
2197
            
1701
2198
            # Start communication using the Mandos protocol
1702
2199
            # Get protocol number
1712
2209
            # Start GnuTLS connection
1713
2210
            try:
1714
2211
                session.handshake()
1715
 
            except gnutls.errors.GNUTLSError as error:
 
2212
            except gnutls.Error as error:
1716
2213
                logger.warning("Handshake failed: %s", error)
1717
2214
                # Do not run session.bye() here: the session is not
1718
2215
                # established.  Just abandon the request.
1722
2219
            approval_required = False
1723
2220
            try:
1724
2221
                try:
1725
 
                    fpr = self.fingerprint(self.peer_certificate
1726
 
                                           (session))
1727
 
                except (TypeError,
1728
 
                        gnutls.errors.GNUTLSError) as error:
 
2222
                    fpr = self.fingerprint(
 
2223
                        self.peer_certificate(session))
 
2224
                except (TypeError, gnutls.Error) as error:
1729
2225
                    logger.warning("Bad certificate: %s", error)
1730
2226
                    return
1731
2227
                logger.debug("Fingerprint: %s", fpr)
1744
2240
                while True:
1745
2241
                    if not client.enabled:
1746
2242
                        logger.info("Client %s is disabled",
1747
 
                                       client.name)
 
2243
                                    client.name)
1748
2244
                        if self.server.use_dbus:
1749
2245
                            # Emit D-Bus signal
1750
2246
                            client.Rejected("Disabled")
1759
2255
                        if self.server.use_dbus:
1760
2256
                            # Emit D-Bus signal
1761
2257
                            client.NeedApproval(
1762
 
                                client.approval_delay_milliseconds(),
1763
 
                                client.approved_by_default)
 
2258
                                client.approval_delay.total_seconds()
 
2259
                                * 1000, client.approved_by_default)
1764
2260
                    else:
1765
2261
                        logger.warning("Client %s was not approved",
1766
2262
                                       client.name)
1772
2268
                    #wait until timeout or approved
1773
2269
                    time = datetime.datetime.now()
1774
2270
                    client.changedstate.acquire()
1775
 
                    client.changedstate.wait(
1776
 
                        float(timedelta_to_milliseconds(delay)
1777
 
                              / 1000))
 
2271
                    client.changedstate.wait(delay.total_seconds())
1778
2272
                    client.changedstate.release()
1779
2273
                    time2 = datetime.datetime.now()
1780
2274
                    if (time2 - time) >= delay:
1791
2285
                    else:
1792
2286
                        delay -= time2 - time
1793
2287
                
1794
 
                sent_size = 0
1795
 
                while sent_size < len(client.secret):
1796
 
                    try:
1797
 
                        sent = session.send(client.secret[sent_size:])
1798
 
                    except gnutls.errors.GNUTLSError as error:
1799
 
                        logger.warning("gnutls send failed",
1800
 
                                       exc_info=error)
1801
 
                        return
1802
 
                    logger.debug("Sent: %d, remaining: %d",
1803
 
                                 sent, len(client.secret)
1804
 
                                 - (sent_size + sent))
1805
 
                    sent_size += sent
 
2288
                try:
 
2289
                    session.send(client.secret)
 
2290
                except gnutls.Error as error:
 
2291
                    logger.warning("gnutls send failed",
 
2292
                                   exc_info = error)
 
2293
                    return
1806
2294
                
1807
2295
                logger.info("Sending secret to %s", client.name)
1808
2296
                # bump the timeout using extended_timeout
1816
2304
                    client.approvals_pending -= 1
1817
2305
                try:
1818
2306
                    session.bye()
1819
 
                except gnutls.errors.GNUTLSError as error:
 
2307
                except gnutls.Error as error:
1820
2308
                    logger.warning("GnuTLS bye failed",
1821
2309
                                   exc_info=error)
1822
2310
    
1824
2312
    def peer_certificate(session):
1825
2313
        "Return the peer's OpenPGP certificate as a bytestring"
1826
2314
        # If not an OpenPGP certificate...
1827
 
        if (gnutls.library.functions
1828
 
            .gnutls_certificate_type_get(session._c_object)
1829
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1830
 
            # ...do the normal thing
1831
 
            return session.peer_certificate
 
2315
        if (gnutls.certificate_type_get(session._c_object)
 
2316
            != gnutls.CRT_OPENPGP):
 
2317
            # ...return invalid data
 
2318
            return b""
1832
2319
        list_size = ctypes.c_uint(1)
1833
 
        cert_list = (gnutls.library.functions
1834
 
                     .gnutls_certificate_get_peers
 
2320
        cert_list = (gnutls.certificate_get_peers
1835
2321
                     (session._c_object, ctypes.byref(list_size)))
1836
2322
        if not bool(cert_list) and list_size.value != 0:
1837
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1838
 
                                            " certificate")
 
2323
            raise gnutls.Error("error getting peer certificate")
1839
2324
        if list_size.value == 0:
1840
2325
            return None
1841
2326
        cert = cert_list[0]
1845
2330
    def fingerprint(openpgp):
1846
2331
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1847
2332
        # New GnuTLS "datum" with the OpenPGP public key
1848
 
        datum = (gnutls.library.types
1849
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1850
 
                                             ctypes.POINTER
1851
 
                                             (ctypes.c_ubyte)),
1852
 
                                 ctypes.c_uint(len(openpgp))))
 
2333
        datum = gnutls.datum_t(
 
2334
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2335
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2336
            ctypes.c_uint(len(openpgp)))
1853
2337
        # New empty GnuTLS certificate
1854
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1855
 
        (gnutls.library.functions
1856
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2338
        crt = gnutls.openpgp_crt_t()
 
2339
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1857
2340
        # Import the OpenPGP public key into the certificate
1858
 
        (gnutls.library.functions
1859
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1860
 
                                    gnutls.library.constants
1861
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2341
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2342
                                  gnutls.OPENPGP_FMT_RAW)
1862
2343
        # Verify the self signature in the key
1863
2344
        crtverify = ctypes.c_uint()
1864
 
        (gnutls.library.functions
1865
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1866
 
                                         ctypes.byref(crtverify)))
 
2345
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2346
                                       ctypes.byref(crtverify))
1867
2347
        if crtverify.value != 0:
1868
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1869
 
            raise (gnutls.errors.CertificateSecurityError
1870
 
                   ("Verify failed"))
 
2348
            gnutls.openpgp_crt_deinit(crt)
 
2349
            raise gnutls.CertificateSecurityError("Verify failed")
1871
2350
        # New buffer for the fingerprint
1872
2351
        buf = ctypes.create_string_buffer(20)
1873
2352
        buf_len = ctypes.c_size_t()
1874
2353
        # Get the fingerprint from the certificate into the buffer
1875
 
        (gnutls.library.functions
1876
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1877
 
                                             ctypes.byref(buf_len)))
 
2354
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2355
                                           ctypes.byref(buf_len))
1878
2356
        # Deinit the certificate
1879
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2357
        gnutls.openpgp_crt_deinit(crt)
1880
2358
        # Convert the buffer to a Python bytestring
1881
2359
        fpr = ctypes.string_at(buf, buf_len.value)
1882
2360
        # Convert the bytestring to hexadecimal notation
1886
2364
 
1887
2365
class MultiprocessingMixIn(object):
1888
2366
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2367
    
1889
2368
    def sub_process_main(self, request, address):
1890
2369
        try:
1891
2370
            self.finish_request(request, address)
1903
2382
 
1904
2383
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1905
2384
    """ adds a pipe to the MixIn """
 
2385
    
1906
2386
    def process_request(self, request, client_address):
1907
2387
        """Overrides and wraps the original process_request().
1908
2388
        
1929
2409
        interface:      None or a network interface name (string)
1930
2410
        use_ipv6:       Boolean; to use IPv6 or not
1931
2411
    """
 
2412
    
1932
2413
    def __init__(self, server_address, RequestHandlerClass,
1933
 
                 interface=None, use_ipv6=True, socketfd=None):
 
2414
                 interface=None,
 
2415
                 use_ipv6=True,
 
2416
                 socketfd=None):
1934
2417
        """If socketfd is set, use that file descriptor instead of
1935
2418
        creating a new one with socket.socket().
1936
2419
        """
1972
2455
        bind to an address or port if they were not specified."""
1973
2456
        if self.interface is not None:
1974
2457
            if SO_BINDTODEVICE is None:
1975
 
                logger.error("SO_BINDTODEVICE does not exist;"
1976
 
                             " cannot bind to interface %s",
1977
 
                             self.interface)
1978
 
            else:
1979
 
                try:
1980
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1981
 
                                           SO_BINDTODEVICE,
1982
 
                                           str(self.interface + '\0'))
1983
 
                except socket.error as error:
1984
 
                    if error.errno == errno.EPERM:
1985
 
                        logger.error("No permission to bind to"
1986
 
                                     " interface %s", self.interface)
1987
 
                    elif error.errno == errno.ENOPROTOOPT:
1988
 
                        logger.error("SO_BINDTODEVICE not available;"
1989
 
                                     " cannot bind to interface %s",
1990
 
                                     self.interface)
1991
 
                    elif error.errno == errno.ENODEV:
1992
 
                        logger.error("Interface %s does not exist,"
1993
 
                                     " cannot bind", self.interface)
1994
 
                    else:
1995
 
                        raise
 
2458
                # Fall back to a hard-coded value which seems to be
 
2459
                # common enough.
 
2460
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2461
                SO_BINDTODEVICE = 25
 
2462
            try:
 
2463
                self.socket.setsockopt(
 
2464
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2465
                    (self.interface + "\0").encode("utf-8"))
 
2466
            except socket.error as error:
 
2467
                if error.errno == errno.EPERM:
 
2468
                    logger.error("No permission to bind to"
 
2469
                                 " interface %s", self.interface)
 
2470
                elif error.errno == errno.ENOPROTOOPT:
 
2471
                    logger.error("SO_BINDTODEVICE not available;"
 
2472
                                 " cannot bind to interface %s",
 
2473
                                 self.interface)
 
2474
                elif error.errno == errno.ENODEV:
 
2475
                    logger.error("Interface %s does not exist,"
 
2476
                                 " cannot bind", self.interface)
 
2477
                else:
 
2478
                    raise
1996
2479
        # Only bind(2) the socket if we really need to.
1997
2480
        if self.server_address[0] or self.server_address[1]:
1998
2481
            if not self.server_address[0]:
2003
2486
                self.server_address = (any_address,
2004
2487
                                       self.server_address[1])
2005
2488
            elif not self.server_address[1]:
2006
 
                self.server_address = (self.server_address[0],
2007
 
                                       0)
 
2489
                self.server_address = (self.server_address[0], 0)
2008
2490
#                 if self.interface:
2009
2491
#                     self.server_address = (self.server_address[0],
2010
2492
#                                            0, # port
2022
2504
        gnutls_priority GnuTLS priority string
2023
2505
        use_dbus:       Boolean; to emit D-Bus signals or not
2024
2506
    
2025
 
    Assumes a gobject.MainLoop event loop.
 
2507
    Assumes a GLib.MainLoop event loop.
2026
2508
    """
 
2509
    
2027
2510
    def __init__(self, server_address, RequestHandlerClass,
2028
 
                 interface=None, use_ipv6=True, clients=None,
2029
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
2511
                 interface=None,
 
2512
                 use_ipv6=True,
 
2513
                 clients=None,
 
2514
                 gnutls_priority=None,
 
2515
                 use_dbus=True,
 
2516
                 socketfd=None):
2030
2517
        self.enabled = False
2031
2518
        self.clients = clients
2032
2519
        if self.clients is None:
2038
2525
                                interface = interface,
2039
2526
                                use_ipv6 = use_ipv6,
2040
2527
                                socketfd = socketfd)
 
2528
    
2041
2529
    def server_activate(self):
2042
2530
        if self.enabled:
2043
2531
            return socketserver.TCPServer.server_activate(self)
2047
2535
    
2048
2536
    def add_pipe(self, parent_pipe, proc):
2049
2537
        # Call "handle_ipc" for both data and EOF events
2050
 
        gobject.io_add_watch(parent_pipe.fileno(),
2051
 
                             gobject.IO_IN | gobject.IO_HUP,
2052
 
                             functools.partial(self.handle_ipc,
2053
 
                                               parent_pipe =
2054
 
                                               parent_pipe,
2055
 
                                               proc = proc))
 
2538
        GLib.io_add_watch(
 
2539
            parent_pipe.fileno(),
 
2540
            GLib.IO_IN | GLib.IO_HUP,
 
2541
            functools.partial(self.handle_ipc,
 
2542
                              parent_pipe = parent_pipe,
 
2543
                              proc = proc))
2056
2544
    
2057
 
    def handle_ipc(self, source, condition, parent_pipe=None,
2058
 
                   proc = None, client_object=None):
 
2545
    def handle_ipc(self, source, condition,
 
2546
                   parent_pipe=None,
 
2547
                   proc = None,
 
2548
                   client_object=None):
2059
2549
        # error, or the other end of multiprocessing.Pipe has closed
2060
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2550
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2061
2551
            # Wait for other process to exit
2062
2552
            proc.join()
2063
2553
            return False
2070
2560
            fpr = request[1]
2071
2561
            address = request[2]
2072
2562
            
2073
 
            for c in self.clients.itervalues():
 
2563
            for c in self.clients.values():
2074
2564
                if c.fingerprint == fpr:
2075
2565
                    client = c
2076
2566
                    break
2084
2574
                parent_pipe.send(False)
2085
2575
                return False
2086
2576
            
2087
 
            gobject.io_add_watch(parent_pipe.fileno(),
2088
 
                                 gobject.IO_IN | gobject.IO_HUP,
2089
 
                                 functools.partial(self.handle_ipc,
2090
 
                                                   parent_pipe =
2091
 
                                                   parent_pipe,
2092
 
                                                   proc = proc,
2093
 
                                                   client_object =
2094
 
                                                   client))
 
2577
            GLib.io_add_watch(
 
2578
                parent_pipe.fileno(),
 
2579
                GLib.IO_IN | GLib.IO_HUP,
 
2580
                functools.partial(self.handle_ipc,
 
2581
                                  parent_pipe = parent_pipe,
 
2582
                                  proc = proc,
 
2583
                                  client_object = client))
2095
2584
            parent_pipe.send(True)
2096
2585
            # remove the old hook in favor of the new above hook on
2097
2586
            # same fileno
2103
2592
            
2104
2593
            parent_pipe.send(('data', getattr(client_object,
2105
2594
                                              funcname)(*args,
2106
 
                                                         **kwargs)))
 
2595
                                                        **kwargs)))
2107
2596
        
2108
2597
        if command == 'getattr':
2109
2598
            attrname = request[1]
2110
 
            if callable(client_object.__getattribute__(attrname)):
2111
 
                parent_pipe.send(('function',))
 
2599
            if isinstance(client_object.__getattribute__(attrname),
 
2600
                          collections.Callable):
 
2601
                parent_pipe.send(('function', ))
2112
2602
            else:
2113
 
                parent_pipe.send(('data', client_object
2114
 
                                  .__getattribute__(attrname)))
 
2603
                parent_pipe.send((
 
2604
                    'data', client_object.__getattribute__(attrname)))
2115
2605
        
2116
2606
        if command == 'setattr':
2117
2607
            attrname = request[1]
2148
2638
    # avoid excessive use of external libraries.
2149
2639
    
2150
2640
    # New type for defining tokens, syntax, and semantics all-in-one
2151
 
    Token = collections.namedtuple("Token",
2152
 
                                   ("regexp", # To match token; if
2153
 
                                              # "value" is not None,
2154
 
                                              # must have a "group"
2155
 
                                              # containing digits
2156
 
                                    "value",  # datetime.timedelta or
2157
 
                                              # None
2158
 
                                    "followers")) # Tokens valid after
2159
 
                                                  # this token
 
2641
    Token = collections.namedtuple("Token", (
 
2642
        "regexp",  # To match token; if "value" is not None, must have
 
2643
                   # a "group" containing digits
 
2644
        "value",   # datetime.timedelta or None
 
2645
        "followers"))           # Tokens valid after this token
2160
2646
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2161
2647
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2162
2648
    token_end = Token(re.compile(r"$"), None, frozenset())
2163
2649
    token_second = Token(re.compile(r"(\d+)S"),
2164
2650
                         datetime.timedelta(seconds=1),
2165
 
                         frozenset((token_end,)))
 
2651
                         frozenset((token_end, )))
2166
2652
    token_minute = Token(re.compile(r"(\d+)M"),
2167
2653
                         datetime.timedelta(minutes=1),
2168
2654
                         frozenset((token_second, token_end)))
2184
2670
                       frozenset((token_month, token_end)))
2185
2671
    token_week = Token(re.compile(r"(\d+)W"),
2186
2672
                       datetime.timedelta(weeks=1),
2187
 
                       frozenset((token_end,)))
 
2673
                       frozenset((token_end, )))
2188
2674
    token_duration = Token(re.compile(r"P"), None,
2189
2675
                           frozenset((token_year, token_month,
2190
2676
                                      token_day, token_time,
2191
 
                                      token_week))),
 
2677
                                      token_week)))
2192
2678
    # Define starting values
2193
2679
    value = datetime.timedelta() # Value so far
2194
2680
    found_token = None
2195
 
    followers = frozenset(token_duration,) # Following valid tokens
 
2681
    followers = frozenset((token_duration, )) # Following valid tokens
2196
2682
    s = duration                # String left to parse
2197
2683
    # Loop until end token is found
2198
2684
    while found_token is not token_end:
2215
2701
                break
2216
2702
        else:
2217
2703
            # No currently valid tokens were found
2218
 
            raise ValueError("Invalid RFC 3339 duration")
 
2704
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2705
                             .format(duration))
2219
2706
    # End token found
2220
2707
    return value
2221
2708
 
2245
2732
    timevalue = datetime.timedelta(0)
2246
2733
    for s in interval.split():
2247
2734
        try:
2248
 
            suffix = unicode(s[-1])
 
2735
            suffix = s[-1]
2249
2736
            value = int(s[:-1])
2250
2737
            if suffix == "d":
2251
2738
                delta = datetime.timedelta(value)
2258
2745
            elif suffix == "w":
2259
2746
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2260
2747
            else:
2261
 
                raise ValueError("Unknown suffix {0!r}"
2262
 
                                 .format(suffix))
 
2748
                raise ValueError("Unknown suffix {!r}".format(suffix))
2263
2749
        except IndexError as e:
2264
2750
            raise ValueError(*(e.args))
2265
2751
        timevalue += delta
2282
2768
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2283
2769
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2284
2770
            raise OSError(errno.ENODEV,
2285
 
                          "{0} not a character device"
 
2771
                          "{} not a character device"
2286
2772
                          .format(os.devnull))
2287
2773
        os.dup2(null, sys.stdin.fileno())
2288
2774
        os.dup2(null, sys.stdout.fileno())
2298
2784
    
2299
2785
    parser = argparse.ArgumentParser()
2300
2786
    parser.add_argument("-v", "--version", action="version",
2301
 
                        version = "%(prog)s {0}".format(version),
 
2787
                        version = "%(prog)s {}".format(version),
2302
2788
                        help="show version number and exit")
2303
2789
    parser.add_argument("-i", "--interface", metavar="IF",
2304
2790
                        help="Bind to interface IF")
2354
2840
                        "port": "",
2355
2841
                        "debug": "False",
2356
2842
                        "priority":
2357
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2843
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2844
                        ":+SIGN-DSA-SHA256",
2358
2845
                        "servicename": "Mandos",
2359
2846
                        "use_dbus": "True",
2360
2847
                        "use_ipv6": "True",
2364
2851
                        "statedir": "/var/lib/mandos",
2365
2852
                        "foreground": "False",
2366
2853
                        "zeroconf": "True",
2367
 
                        }
 
2854
                    }
2368
2855
    
2369
2856
    # Parse config file for server-global settings
2370
2857
    server_config = configparser.SafeConfigParser(server_defaults)
2371
2858
    del server_defaults
2372
 
    server_config.read(os.path.join(options.configdir,
2373
 
                                    "mandos.conf"))
 
2859
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2374
2860
    # Convert the SafeConfigParser object to a dict
2375
2861
    server_settings = server_config.defaults()
2376
2862
    # Use the appropriate methods on the non-string config options
2394
2880
    # Override the settings from the config file with command line
2395
2881
    # options, if set.
2396
2882
    for option in ("interface", "address", "port", "debug",
2397
 
                   "priority", "servicename", "configdir",
2398
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2399
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2883
                   "priority", "servicename", "configdir", "use_dbus",
 
2884
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2885
                   "socket", "foreground", "zeroconf"):
2400
2886
        value = getattr(options, option)
2401
2887
        if value is not None:
2402
2888
            server_settings[option] = value
2403
2889
    del options
2404
2890
    # Force all strings to be unicode
2405
2891
    for option in server_settings.keys():
2406
 
        if type(server_settings[option]) is str:
2407
 
            server_settings[option] = unicode(server_settings[option])
 
2892
        if isinstance(server_settings[option], bytes):
 
2893
            server_settings[option] = (server_settings[option]
 
2894
                                       .decode("utf-8"))
2408
2895
    # Force all boolean options to be boolean
2409
2896
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2410
2897
                   "foreground", "zeroconf"):
2416
2903
    
2417
2904
    ##################################################################
2418
2905
    
2419
 
    if (not server_settings["zeroconf"] and
2420
 
        not (server_settings["port"]
2421
 
             or server_settings["socket"] != "")):
2422
 
            parser.error("Needs port or socket to work without"
2423
 
                         " Zeroconf")
 
2906
    if (not server_settings["zeroconf"]
 
2907
        and not (server_settings["port"]
 
2908
                 or server_settings["socket"] != "")):
 
2909
        parser.error("Needs port or socket to work without Zeroconf")
2424
2910
    
2425
2911
    # For convenience
2426
2912
    debug = server_settings["debug"]
2442
2928
            initlogger(debug, level)
2443
2929
    
2444
2930
    if server_settings["servicename"] != "Mandos":
2445
 
        syslogger.setFormatter(logging.Formatter
2446
 
                               ('Mandos ({0}) [%(process)d]:'
2447
 
                                ' %(levelname)s: %(message)s'
2448
 
                                .format(server_settings
2449
 
                                        ["servicename"])))
 
2931
        syslogger.setFormatter(
 
2932
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2933
                              ' %(levelname)s: %(message)s'.format(
 
2934
                                  server_settings["servicename"])))
2450
2935
    
2451
2936
    # Parse config file with clients
2452
2937
    client_config = configparser.SafeConfigParser(Client
2460
2945
    socketfd = None
2461
2946
    if server_settings["socket"] != "":
2462
2947
        socketfd = server_settings["socket"]
2463
 
    tcp_server = MandosServer((server_settings["address"],
2464
 
                               server_settings["port"]),
2465
 
                              ClientHandler,
2466
 
                              interface=(server_settings["interface"]
2467
 
                                         or None),
2468
 
                              use_ipv6=use_ipv6,
2469
 
                              gnutls_priority=
2470
 
                              server_settings["priority"],
2471
 
                              use_dbus=use_dbus,
2472
 
                              socketfd=socketfd)
 
2948
    tcp_server = MandosServer(
 
2949
        (server_settings["address"], server_settings["port"]),
 
2950
        ClientHandler,
 
2951
        interface=(server_settings["interface"] or None),
 
2952
        use_ipv6=use_ipv6,
 
2953
        gnutls_priority=server_settings["priority"],
 
2954
        use_dbus=use_dbus,
 
2955
        socketfd=socketfd)
2473
2956
    if not foreground:
2474
2957
        pidfilename = "/run/mandos.pid"
2475
2958
        if not os.path.isdir("/run/."):
2476
2959
            pidfilename = "/var/run/mandos.pid"
2477
2960
        pidfile = None
2478
2961
        try:
2479
 
            pidfile = open(pidfilename, "w")
 
2962
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2480
2963
        except IOError as e:
2481
2964
            logger.error("Could not open file %r", pidfilename,
2482
2965
                         exc_info=e)
2483
2966
    
2484
 
    for name in ("_mandos", "mandos", "nobody"):
 
2967
    for name, group in (("_mandos", "_mandos"),
 
2968
                        ("mandos", "mandos"),
 
2969
                        ("nobody", "nogroup")):
2485
2970
        try:
2486
2971
            uid = pwd.getpwnam(name).pw_uid
2487
 
            gid = pwd.getpwnam(name).pw_gid
 
2972
            gid = pwd.getpwnam(group).pw_gid
2488
2973
            break
2489
2974
        except KeyError:
2490
2975
            continue
2494
2979
    try:
2495
2980
        os.setgid(gid)
2496
2981
        os.setuid(uid)
 
2982
        if debug:
 
2983
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
2984
                                                             gid))
2497
2985
    except OSError as error:
 
2986
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
2987
                       .format(uid, gid, os.strerror(error.errno)))
2498
2988
        if error.errno != errno.EPERM:
2499
2989
            raise
2500
2990
    
2503
2993
        
2504
2994
        # "Use a log level over 10 to enable all debugging options."
2505
2995
        # - GnuTLS manual
2506
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2996
        gnutls.global_set_log_level(11)
2507
2997
        
2508
 
        @gnutls.library.types.gnutls_log_func
 
2998
        @gnutls.log_func
2509
2999
        def debug_gnutls(level, string):
2510
3000
            logger.debug("GnuTLS: %s", string[:-1])
2511
3001
        
2512
 
        (gnutls.library.functions
2513
 
         .gnutls_global_set_log_function(debug_gnutls))
 
3002
        gnutls.global_set_log_function(debug_gnutls)
2514
3003
        
2515
3004
        # Redirect stdin so all checkers get /dev/null
2516
3005
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2523
3012
        # Close all input and output, do double fork, etc.
2524
3013
        daemon()
2525
3014
    
2526
 
    # multiprocessing will use threads, so before we use gobject we
2527
 
    # need to inform gobject that threads will be used.
2528
 
    gobject.threads_init()
 
3015
    # multiprocessing will use threads, so before we use GLib we need
 
3016
    # to inform GLib that threads will be used.
 
3017
    GLib.threads_init()
2529
3018
    
2530
3019
    global main_loop
2531
3020
    # From the Avahi example code
2532
3021
    DBusGMainLoop(set_as_default=True)
2533
 
    main_loop = gobject.MainLoop()
 
3022
    main_loop = GLib.MainLoop()
2534
3023
    bus = dbus.SystemBus()
2535
3024
    # End of Avahi example code
2536
3025
    if use_dbus:
2537
3026
        try:
2538
3027
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2539
 
                                            bus, do_not_queue=True)
2540
 
            old_bus_name = (dbus.service.BusName
2541
 
                            ("se.bsnet.fukt.Mandos", bus,
2542
 
                             do_not_queue=True))
2543
 
        except dbus.exceptions.NameExistsException as e:
 
3028
                                            bus,
 
3029
                                            do_not_queue=True)
 
3030
            old_bus_name = dbus.service.BusName(
 
3031
                "se.bsnet.fukt.Mandos", bus,
 
3032
                do_not_queue=True)
 
3033
        except dbus.exceptions.DBusException as e:
2544
3034
            logger.error("Disabling D-Bus:", exc_info=e)
2545
3035
            use_dbus = False
2546
3036
            server_settings["use_dbus"] = False
2547
3037
            tcp_server.use_dbus = False
2548
3038
    if zeroconf:
2549
3039
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2550
 
        service = AvahiServiceToSyslog(name =
2551
 
                                       server_settings["servicename"],
2552
 
                                       servicetype = "_mandos._tcp",
2553
 
                                       protocol = protocol, bus = bus)
 
3040
        service = AvahiServiceToSyslog(
 
3041
            name = server_settings["servicename"],
 
3042
            servicetype = "_mandos._tcp",
 
3043
            protocol = protocol,
 
3044
            bus = bus)
2554
3045
        if server_settings["interface"]:
2555
 
            service.interface = (if_nametoindex
2556
 
                                 (str(server_settings["interface"])))
 
3046
            service.interface = if_nametoindex(
 
3047
                server_settings["interface"].encode("utf-8"))
2557
3048
    
2558
3049
    global multiprocessing_manager
2559
3050
    multiprocessing_manager = multiprocessing.Manager()
2578
3069
    if server_settings["restore"]:
2579
3070
        try:
2580
3071
            with open(stored_state_path, "rb") as stored_state:
2581
 
                clients_data, old_client_settings = (pickle.load
2582
 
                                                     (stored_state))
 
3072
                if sys.version_info.major == 2:                
 
3073
                    clients_data, old_client_settings = pickle.load(
 
3074
                        stored_state)
 
3075
                else:
 
3076
                    bytes_clients_data, bytes_old_client_settings = (
 
3077
                        pickle.load(stored_state, encoding = "bytes"))
 
3078
                    ### Fix bytes to strings
 
3079
                    ## clients_data
 
3080
                    # .keys()
 
3081
                    clients_data = { (key.decode("utf-8")
 
3082
                                      if isinstance(key, bytes)
 
3083
                                      else key): value
 
3084
                                     for key, value in
 
3085
                                     bytes_clients_data.items() }
 
3086
                    del bytes_clients_data
 
3087
                    for key in clients_data:
 
3088
                        value = { (k.decode("utf-8")
 
3089
                                   if isinstance(k, bytes) else k): v
 
3090
                                  for k, v in
 
3091
                                  clients_data[key].items() }
 
3092
                        clients_data[key] = value
 
3093
                        # .client_structure
 
3094
                        value["client_structure"] = [
 
3095
                            (s.decode("utf-8")
 
3096
                             if isinstance(s, bytes)
 
3097
                             else s) for s in
 
3098
                            value["client_structure"] ]
 
3099
                        # .name & .host
 
3100
                        for k in ("name", "host"):
 
3101
                            if isinstance(value[k], bytes):
 
3102
                                value[k] = value[k].decode("utf-8")
 
3103
                    ## old_client_settings
 
3104
                    # .keys()
 
3105
                    old_client_settings = {
 
3106
                        (key.decode("utf-8")
 
3107
                         if isinstance(key, bytes)
 
3108
                         else key): value
 
3109
                        for key, value in
 
3110
                        bytes_old_client_settings.items() }
 
3111
                    del bytes_old_client_settings
 
3112
                    # .host
 
3113
                    for value in old_client_settings.values():
 
3114
                        if isinstance(value["host"], bytes):
 
3115
                            value["host"] = (value["host"]
 
3116
                                             .decode("utf-8"))
2583
3117
            os.remove(stored_state_path)
2584
3118
        except IOError as e:
2585
3119
            if e.errno == errno.ENOENT:
2586
 
                logger.warning("Could not load persistent state: {0}"
2587
 
                                .format(os.strerror(e.errno)))
 
3120
                logger.warning("Could not load persistent state:"
 
3121
                               " {}".format(os.strerror(e.errno)))
2588
3122
            else:
2589
3123
                logger.critical("Could not load persistent state:",
2590
3124
                                exc_info=e)
2591
3125
                raise
2592
3126
        except EOFError as e:
2593
3127
            logger.warning("Could not load persistent state: "
2594
 
                           "EOFError:", exc_info=e)
 
3128
                           "EOFError:",
 
3129
                           exc_info=e)
2595
3130
    
2596
3131
    with PGPEngine() as pgp:
2597
 
        for client_name, client in clients_data.iteritems():
 
3132
        for client_name, client in clients_data.items():
2598
3133
            # Skip removed clients
2599
3134
            if client_name not in client_settings:
2600
3135
                continue
2609
3144
                    # For each value in new config, check if it
2610
3145
                    # differs from the old config value (Except for
2611
3146
                    # the "secret" attribute)
2612
 
                    if (name != "secret" and
2613
 
                        value != old_client_settings[client_name]
2614
 
                        [name]):
 
3147
                    if (name != "secret"
 
3148
                        and (value !=
 
3149
                             old_client_settings[client_name][name])):
2615
3150
                        client[name] = value
2616
3151
                except KeyError:
2617
3152
                    pass
2618
3153
            
2619
3154
            # Clients who has passed its expire date can still be
2620
 
            # enabled if its last checker was successful.  Clients
 
3155
            # enabled if its last checker was successful.  A Client
2621
3156
            # whose checker succeeded before we stored its state is
2622
3157
            # assumed to have successfully run all checkers during
2623
3158
            # downtime.
2625
3160
                if datetime.datetime.utcnow() >= client["expires"]:
2626
3161
                    if not client["last_checked_ok"]:
2627
3162
                        logger.warning(
2628
 
                            "disabling client {0} - Client never "
2629
 
                            "performed a successful checker"
2630
 
                            .format(client_name))
 
3163
                            "disabling client {} - Client never "
 
3164
                            "performed a successful checker".format(
 
3165
                                client_name))
2631
3166
                        client["enabled"] = False
2632
3167
                    elif client["last_checker_status"] != 0:
2633
3168
                        logger.warning(
2634
 
                            "disabling client {0} - Client "
2635
 
                            "last checker failed with error code {1}"
2636
 
                            .format(client_name,
2637
 
                                    client["last_checker_status"]))
 
3169
                            "disabling client {} - Client last"
 
3170
                            " checker failed with error code"
 
3171
                            " {}".format(
 
3172
                                client_name,
 
3173
                                client["last_checker_status"]))
2638
3174
                        client["enabled"] = False
2639
3175
                    else:
2640
 
                        client["expires"] = (datetime.datetime
2641
 
                                             .utcnow()
2642
 
                                             + client["timeout"])
 
3176
                        client["expires"] = (
 
3177
                            datetime.datetime.utcnow()
 
3178
                            + client["timeout"])
2643
3179
                        logger.debug("Last checker succeeded,"
2644
 
                                     " keeping {0} enabled"
2645
 
                                     .format(client_name))
 
3180
                                     " keeping {} enabled".format(
 
3181
                                         client_name))
2646
3182
            try:
2647
 
                client["secret"] = (
2648
 
                    pgp.decrypt(client["encrypted_secret"],
2649
 
                                client_settings[client_name]
2650
 
                                ["secret"]))
 
3183
                client["secret"] = pgp.decrypt(
 
3184
                    client["encrypted_secret"],
 
3185
                    client_settings[client_name]["secret"])
2651
3186
            except PGPError:
2652
3187
                # If decryption fails, we use secret from new settings
2653
 
                logger.debug("Failed to decrypt {0} old secret"
2654
 
                             .format(client_name))
2655
 
                client["secret"] = (
2656
 
                    client_settings[client_name]["secret"])
 
3188
                logger.debug("Failed to decrypt {} old secret".format(
 
3189
                    client_name))
 
3190
                client["secret"] = (client_settings[client_name]
 
3191
                                    ["secret"])
2657
3192
    
2658
3193
    # Add/remove clients based on new changes made to config
2659
3194
    for client_name in (set(old_client_settings)
2664
3199
        clients_data[client_name] = client_settings[client_name]
2665
3200
    
2666
3201
    # Create all client objects
2667
 
    for client_name, client in clients_data.iteritems():
 
3202
    for client_name, client in clients_data.items():
2668
3203
        tcp_server.clients[client_name] = client_class(
2669
 
            name = client_name, settings = client,
 
3204
            name = client_name,
 
3205
            settings = client,
2670
3206
            server_settings = server_settings)
2671
3207
    
2672
3208
    if not tcp_server.clients:
2674
3210
    
2675
3211
    if not foreground:
2676
3212
        if pidfile is not None:
 
3213
            pid = os.getpid()
2677
3214
            try:
2678
3215
                with pidfile:
2679
 
                    pid = os.getpid()
2680
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
3216
                    print(pid, file=pidfile)
2681
3217
            except IOError:
2682
3218
                logger.error("Could not write to file %r with PID %d",
2683
3219
                             pidfilename, pid)
2684
3220
        del pidfile
2685
3221
        del pidfilename
2686
3222
    
2687
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2688
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
3223
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3224
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3225
                             lambda: main_loop.quit() and False)
2689
3226
    
2690
3227
    if use_dbus:
2691
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2692
 
                                        "se.bsnet.fukt.Mandos"})
2693
 
        class MandosDBusService(DBusObjectWithProperties):
 
3228
        
 
3229
        @alternate_dbus_interfaces(
 
3230
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
3231
        class MandosDBusService(DBusObjectWithObjectManager):
2694
3232
            """A D-Bus proxy object"""
 
3233
            
2695
3234
            def __init__(self):
2696
3235
                dbus.service.Object.__init__(self, bus, "/")
 
3236
            
2697
3237
            _interface = "se.recompile.Mandos"
2698
3238
            
2699
 
            @dbus_interface_annotations(_interface)
2700
 
            def _foo(self):
2701
 
                return { "org.freedesktop.DBus.Property"
2702
 
                         ".EmitsChangedSignal":
2703
 
                             "false"}
2704
 
            
2705
3239
            @dbus.service.signal(_interface, signature="o")
2706
3240
            def ClientAdded(self, objpath):
2707
3241
                "D-Bus signal"
2712
3246
                "D-Bus signal"
2713
3247
                pass
2714
3248
            
 
3249
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3250
                               "true"})
2715
3251
            @dbus.service.signal(_interface, signature="os")
2716
3252
            def ClientRemoved(self, objpath, name):
2717
3253
                "D-Bus signal"
2718
3254
                pass
2719
3255
            
 
3256
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3257
                               "true"})
2720
3258
            @dbus.service.method(_interface, out_signature="ao")
2721
3259
            def GetAllClients(self):
2722
3260
                "D-Bus method"
2723
 
                return dbus.Array(c.dbus_object_path
2724
 
                                  for c in
2725
 
                                  tcp_server.clients.itervalues())
 
3261
                return dbus.Array(c.dbus_object_path for c in
 
3262
                                  tcp_server.clients.values())
2726
3263
            
 
3264
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3265
                               "true"})
2727
3266
            @dbus.service.method(_interface,
2728
3267
                                 out_signature="a{oa{sv}}")
2729
3268
            def GetAllClientsWithProperties(self):
2730
3269
                "D-Bus method"
2731
3270
                return dbus.Dictionary(
2732
 
                    ((c.dbus_object_path, c.GetAll(""))
2733
 
                     for c in tcp_server.clients.itervalues()),
 
3271
                    { c.dbus_object_path: c.GetAll(
 
3272
                        "se.recompile.Mandos.Client")
 
3273
                      for c in tcp_server.clients.values() },
2734
3274
                    signature="oa{sv}")
2735
3275
            
2736
3276
            @dbus.service.method(_interface, in_signature="o")
2737
3277
            def RemoveClient(self, object_path):
2738
3278
                "D-Bus method"
2739
 
                for c in tcp_server.clients.itervalues():
 
3279
                for c in tcp_server.clients.values():
2740
3280
                    if c.dbus_object_path == object_path:
2741
3281
                        del tcp_server.clients[c.name]
2742
3282
                        c.remove_from_connection()
2743
 
                        # Don't signal anything except ClientRemoved
 
3283
                        # Don't signal the disabling
2744
3284
                        c.disable(quiet=True)
2745
 
                        # Emit D-Bus signal
2746
 
                        self.ClientRemoved(object_path, c.name)
 
3285
                        # Emit D-Bus signal for removal
 
3286
                        self.client_removed_signal(c)
2747
3287
                        return
2748
3288
                raise KeyError(object_path)
2749
3289
            
2750
3290
            del _interface
 
3291
            
 
3292
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3293
                                 out_signature = "a{oa{sa{sv}}}")
 
3294
            def GetManagedObjects(self):
 
3295
                """D-Bus method"""
 
3296
                return dbus.Dictionary(
 
3297
                    { client.dbus_object_path:
 
3298
                      dbus.Dictionary(
 
3299
                          { interface: client.GetAll(interface)
 
3300
                            for interface in
 
3301
                                 client._get_all_interface_names()})
 
3302
                      for client in tcp_server.clients.values()})
 
3303
            
 
3304
            def client_added_signal(self, client):
 
3305
                """Send the new standard signal and the old signal"""
 
3306
                if use_dbus:
 
3307
                    # New standard signal
 
3308
                    self.InterfacesAdded(
 
3309
                        client.dbus_object_path,
 
3310
                        dbus.Dictionary(
 
3311
                            { interface: client.GetAll(interface)
 
3312
                              for interface in
 
3313
                              client._get_all_interface_names()}))
 
3314
                    # Old signal
 
3315
                    self.ClientAdded(client.dbus_object_path)
 
3316
            
 
3317
            def client_removed_signal(self, client):
 
3318
                """Send the new standard signal and the old signal"""
 
3319
                if use_dbus:
 
3320
                    # New standard signal
 
3321
                    self.InterfacesRemoved(
 
3322
                        client.dbus_object_path,
 
3323
                        client._get_all_interface_names())
 
3324
                    # Old signal
 
3325
                    self.ClientRemoved(client.dbus_object_path,
 
3326
                                       client.name)
2751
3327
        
2752
3328
        mandos_dbus_service = MandosDBusService()
2753
3329
    
 
3330
    # Save modules to variables to exempt the modules from being
 
3331
    # unloaded before the function registered with atexit() is run.
 
3332
    mp = multiprocessing
 
3333
    wn = wnull
2754
3334
    def cleanup():
2755
3335
        "Cleanup function; run on exit"
2756
3336
        if zeroconf:
2757
3337
            service.cleanup()
2758
3338
        
2759
 
        multiprocessing.active_children()
2760
 
        wnull.close()
 
3339
        mp.active_children()
 
3340
        wn.close()
2761
3341
        if not (tcp_server.clients or client_settings):
2762
3342
            return
2763
3343
        
2766
3346
        # removed/edited, old secret will thus be unrecovable.
2767
3347
        clients = {}
2768
3348
        with PGPEngine() as pgp:
2769
 
            for client in tcp_server.clients.itervalues():
 
3349
            for client in tcp_server.clients.values():
2770
3350
                key = client_settings[client.name]["secret"]
2771
3351
                client.encrypted_secret = pgp.encrypt(client.secret,
2772
3352
                                                      key)
2774
3354
                
2775
3355
                # A list of attributes that can not be pickled
2776
3356
                # + secret.
2777
 
                exclude = set(("bus", "changedstate", "secret",
2778
 
                               "checker", "server_settings"))
2779
 
                for name, typ in (inspect.getmembers
2780
 
                                  (dbus.service.Object)):
 
3357
                exclude = { "bus", "changedstate", "secret",
 
3358
                            "checker", "server_settings" }
 
3359
                for name, typ in inspect.getmembers(dbus.service
 
3360
                                                    .Object):
2781
3361
                    exclude.add(name)
2782
3362
                
2783
3363
                client_dict["encrypted_secret"] = (client
2790
3370
                del client_settings[client.name]["secret"]
2791
3371
        
2792
3372
        try:
2793
 
            with (tempfile.NamedTemporaryFile
2794
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2795
 
                   dir=os.path.dirname(stored_state_path),
2796
 
                   delete=False)) as stored_state:
2797
 
                pickle.dump((clients, client_settings), stored_state)
2798
 
                tempname=stored_state.name
 
3373
            with tempfile.NamedTemporaryFile(
 
3374
                    mode='wb',
 
3375
                    suffix=".pickle",
 
3376
                    prefix='clients-',
 
3377
                    dir=os.path.dirname(stored_state_path),
 
3378
                    delete=False) as stored_state:
 
3379
                pickle.dump((clients, client_settings), stored_state,
 
3380
                            protocol = 2)
 
3381
                tempname = stored_state.name
2799
3382
            os.rename(tempname, stored_state_path)
2800
3383
        except (IOError, OSError) as e:
2801
3384
            if not debug:
2804
3387
                except NameError:
2805
3388
                    pass
2806
3389
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2807
 
                logger.warning("Could not save persistent state: {0}"
 
3390
                logger.warning("Could not save persistent state: {}"
2808
3391
                               .format(os.strerror(e.errno)))
2809
3392
            else:
2810
3393
                logger.warning("Could not save persistent state:",
2816
3399
            name, client = tcp_server.clients.popitem()
2817
3400
            if use_dbus:
2818
3401
                client.remove_from_connection()
2819
 
            # Don't signal anything except ClientRemoved
 
3402
            # Don't signal the disabling
2820
3403
            client.disable(quiet=True)
 
3404
            # Emit D-Bus signal for removal
2821
3405
            if use_dbus:
2822
 
                # Emit D-Bus signal
2823
 
                mandos_dbus_service.ClientRemoved(client
2824
 
                                                  .dbus_object_path,
2825
 
                                                  client.name)
 
3406
                mandos_dbus_service.client_removed_signal(client)
2826
3407
        client_settings.clear()
2827
3408
    
2828
3409
    atexit.register(cleanup)
2829
3410
    
2830
 
    for client in tcp_server.clients.itervalues():
 
3411
    for client in tcp_server.clients.values():
2831
3412
        if use_dbus:
2832
 
            # Emit D-Bus signal
2833
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3413
            # Emit D-Bus signal for adding
 
3414
            mandos_dbus_service.client_added_signal(client)
2834
3415
        # Need to initiate checking of clients
2835
3416
        if client.enabled:
2836
3417
            client.init_checker()
2862
3443
                sys.exit(1)
2863
3444
            # End of Avahi example code
2864
3445
        
2865
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2866
 
                             lambda *args, **kwargs:
2867
 
                             (tcp_server.handle_request
2868
 
                              (*args[2:], **kwargs) or True))
 
3446
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3447
                          lambda *args, **kwargs:
 
3448
                          (tcp_server.handle_request
 
3449
                           (*args[2:], **kwargs) or True))
2869
3450
        
2870
3451
        logger.debug("Starting main loop")
2871
3452
        main_loop.run()
2881
3462
    # Must run before the D-Bus bus name gets deregistered
2882
3463
    cleanup()
2883
3464
 
 
3465
 
2884
3466
if __name__ == '__main__':
2885
3467
    main()