/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: 2019-04-08 21:53:22 UTC
  • Revision ID: teddy@recompile.se-20190408215322-y3hmfxzdgs9t84l1
plugin-runner: Fix minor memory leak

* plugin-runner.c (free_plugin): Even if argv[0] is NULL, as for the
                                 pseudo-plugin for global options,
                                 free all other arguments by simply
                                 starting at argv[1] and freeing
                                 plugin_node->name (which is always
                                 argv[0]) separately.

Show diffs side-by-side

added added

removed removed

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