/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2017-08-20 14:14:14 UTC
  • Revision ID: teddy@recompile.se-20170820141414-m034xuebg7ccaeui
Add some more restrictions to the systemd service file.

* mandos.service ([Service]/ProtectKernelTunables): New; set to "yes".
  ([Service]/ProtectControlGroups): - '' -

Show diffs side-by-side

added added

removed removed

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