/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: 2015-05-25 07:54:07 UTC
  • mto: This revision was merged to the branch mainline in revision 756.
  • Revision ID: teddy@recompile.se-20150525075407-x7u0z4f1zej6bm87
mandos (subprocess_call_pipe): Rename to "call_pipe" and take "func".

Generalize "subprocess_call_pipe" to "call_pipe" which takes an
additional "func" argument which is the function to be run.

Show diffs side-by-side

added added

removed removed

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