/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-08-02 22:16:53 UTC
  • mto: This revision was merged to the branch mainline in revision 386.
  • Revision ID: teddy@recompile.se-20190802221653-ic1iko9hbefzwsk7
Fix bug in server Debian package: Fails to start on first install

There has been a very long-standing bug where installation of the
server (the "mandos" Debian package) would fail to start the server
properly right after installation.  It would work on manual (re)start
after installation, or after reboot, and even after package purge and
reinstall, it would then work the first time.  The problem, it turns
out, is when the new "_mandos" user (and corresponding group) is
created, the D-Bus server is not reloaded, and is therefore not aware
of that user, and does not recognize the user and group name in the
/etc/dbus-1/system.d/mandos.conf file.  The Mandos server, when it
tries to start and access the D-Bus, is then not permitted to connect
to its D-Bus bus name, and disables D-Bus use as a fallback measure;
i.e. the server works, but it is not controllable via D-Bus commands
(via mandos-ctl or mandos-monitor).  The next time the D-Bus daemon is
reloaded for any reason, the new user & group would become visible to
the D-Bus daemon and after that, any restart of the Mandos server
would succeed and it would bind to its D-Bus name properly, and
thereby be visible and controllable by mandos-ctl & mandos-monitor.
This was mostly invisible when using sysvinit, but systemd makes the
problem visible since the systemd service file for the Mandos server
is configured to not consider the Mandos server "started" until the
D-Bus name has been bound; this makes the starting of the service wait
for 90 seconds and then fail with a timeout error.

Fixing this should also make the Debian CI autopkgtest tests work.

* debian/mandos.postinst (configure): After creating (or renaming)
                                      user & group, reload D-Bus
                                      daemon (if present).

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.7.0"
 
118
version = "1.8.5"
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(b"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(b"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
454
823
    approval_duration: datetime.timedelta(); Duration of one approval
455
 
    checker:    subprocess.Popen(); a running checker process used
456
 
                                    to see if the client lives.
457
 
                                    'None' if no process is running.
458
 
    checker_callback_tag: a gobject event source tag, or None
 
824
    checker: multiprocessing.Process(); a running checker process used
 
825
             to see if the client lives. 'None' if no process is
 
826
             running.
 
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."""
663
 
        self.checker_callback_tag = None
664
 
        self.checker = None
665
1039
        # Read return code from connection (see call_pipe)
666
1040
        returncode = connection.recv()
667
1041
        connection.close()
668
 
        
 
1042
        self.checker.join()
 
1043
        self.checker_callback_tag = None
 
1044
        self.checker = None
 
1045
 
669
1046
        if returncode >= 0:
670
1047
            self.last_checker_status = returncode
671
1048
            self.last_checker_signal = None
681
1058
            logger.warning("Checker for %(name)s crashed?",
682
1059
                           vars(self))
683
1060
        return False
684
 
    
 
1061
 
685
1062
    def checked_ok(self):
686
1063
        """Assert that the client has been seen, alive and well."""
687
1064
        self.last_checked_ok = datetime.datetime.utcnow()
688
1065
        self.last_checker_status = 0
689
1066
        self.last_checker_signal = None
690
1067
        self.bump_timeout()
691
 
    
 
1068
 
692
1069
    def bump_timeout(self, timeout=None):
693
1070
        """Bump up the timeout for this client."""
694
1071
        if timeout is None:
695
1072
            timeout = self.timeout
696
1073
        if self.disable_initiator_tag is not None:
697
 
            gobject.source_remove(self.disable_initiator_tag)
 
1074
            GLib.source_remove(self.disable_initiator_tag)
698
1075
            self.disable_initiator_tag = None
699
1076
        if getattr(self, "enabled", False):
700
 
            self.disable_initiator_tag = gobject.timeout_add(
 
1077
            self.disable_initiator_tag = GLib.timeout_add(
701
1078
                int(timeout.total_seconds() * 1000), self.disable)
702
1079
            self.expires = datetime.datetime.utcnow() + timeout
703
 
    
 
1080
 
704
1081
    def need_approval(self):
705
1082
        self.last_approval_request = datetime.datetime.utcnow()
706
 
    
 
1083
 
707
1084
    def start_checker(self):
708
1085
        """Start a new checker subprocess if one is not running.
709
 
        
 
1086
 
710
1087
        If a checker already exists, leave it running and do
711
1088
        nothing."""
712
1089
        # The reason for not killing a running checker is that if we
717
1094
        # checkers alone, the checker would have to take more time
718
1095
        # than 'timeout' for the client to be disabled, which is as it
719
1096
        # should be.
720
 
        
 
1097
 
721
1098
        if self.checker is not None and not self.checker.is_alive():
722
1099
            logger.warning("Checker was not alive; joining")
723
1100
            self.checker.join()
727
1104
            # Escape attributes for the shell
728
1105
            escaped_attrs = {
729
1106
                attr: re.escape(str(getattr(self, attr)))
730
 
                for attr in self.runtime_expansions }
 
1107
                for attr in self.runtime_expansions}
731
1108
            try:
732
1109
                command = self.checker_command % escaped_attrs
733
1110
            except TypeError as error:
745
1122
            # The exception is when not debugging but nevertheless
746
1123
            # running in the foreground; use the previously
747
1124
            # created wnull.
748
 
            popen_args = { "close_fds": True,
749
 
                           "shell": True,
750
 
                           "cwd": "/" }
 
1125
            popen_args = {"close_fds": True,
 
1126
                          "shell": True,
 
1127
                          "cwd": "/"}
751
1128
            if (not self.server_settings["debug"]
752
1129
                and self.server_settings["foreground"]):
753
1130
                popen_args.update({"stdout": wnull,
754
 
                                   "stderr": wnull })
755
 
            pipe = multiprocessing.Pipe(duplex = False)
 
1131
                                   "stderr": wnull})
 
1132
            pipe = multiprocessing.Pipe(duplex=False)
756
1133
            self.checker = multiprocessing.Process(
757
 
                target = call_pipe,
758
 
                args = (pipe[1], subprocess.call, command),
759
 
                kwargs = popen_args)
 
1134
                target=call_pipe,
 
1135
                args=(pipe[1], subprocess.call, command),
 
1136
                kwargs=popen_args)
760
1137
            self.checker.start()
761
 
            self.checker_callback_tag = gobject.io_add_watch(
762
 
                pipe[0].fileno(), gobject.IO_IN,
 
1138
            self.checker_callback_tag = GLib.io_add_watch(
 
1139
                pipe[0].fileno(), GLib.IO_IN,
763
1140
                self.checker_callback, pipe[0], command)
764
 
        # Re-run this periodically if run by gobject.timeout_add
 
1141
        # Re-run this periodically if run by GLib.timeout_add
765
1142
        return True
766
 
    
 
1143
 
767
1144
    def stop_checker(self):
768
1145
        """Force the checker process, if any, to stop."""
769
1146
        if self.checker_callback_tag:
770
 
            gobject.source_remove(self.checker_callback_tag)
 
1147
            GLib.source_remove(self.checker_callback_tag)
771
1148
            self.checker_callback_tag = None
772
1149
        if getattr(self, "checker", None) is None:
773
1150
            return
782
1159
                          byte_arrays=False):
783
1160
    """Decorators for marking methods of a DBusObjectWithProperties to
784
1161
    become properties on the D-Bus.
785
 
    
 
1162
 
786
1163
    The decorated method will be called with no arguments by "Get"
787
1164
    and with one argument by "Set".
788
 
    
 
1165
 
789
1166
    The parameters, where they are supported, are the same as
790
1167
    dbus.service.method, except there is only "signature", since the
791
1168
    type from Get() and the type sent to Set() is the same.
795
1172
    if byte_arrays and signature != "ay":
796
1173
        raise ValueError("Byte arrays not supported for non-'ay'"
797
1174
                         " signature {!r}".format(signature))
798
 
    
 
1175
 
799
1176
    def decorator(func):
800
1177
        func._dbus_is_property = True
801
1178
        func._dbus_interface = dbus_interface
804
1181
        func._dbus_name = func.__name__
805
1182
        if func._dbus_name.endswith("_dbus_property"):
806
1183
            func._dbus_name = func._dbus_name[:-14]
807
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
1184
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
808
1185
        return func
809
 
    
 
1186
 
810
1187
    return decorator
811
1188
 
812
1189
 
813
1190
def dbus_interface_annotations(dbus_interface):
814
1191
    """Decorator for marking functions returning interface annotations
815
 
    
 
1192
 
816
1193
    Usage:
817
 
    
 
1194
 
818
1195
    @dbus_interface_annotations("org.example.Interface")
819
1196
    def _foo(self):  # Function name does not matter
820
1197
        return {"org.freedesktop.DBus.Deprecated": "true",
821
1198
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
822
1199
                    "false"}
823
1200
    """
824
 
    
 
1201
 
825
1202
    def decorator(func):
826
1203
        func._dbus_is_interface = True
827
1204
        func._dbus_interface = dbus_interface
828
1205
        func._dbus_name = dbus_interface
829
1206
        return func
830
 
    
 
1207
 
831
1208
    return decorator
832
1209
 
833
1210
 
834
1211
def dbus_annotations(annotations):
835
1212
    """Decorator to annotate D-Bus methods, signals or properties
836
1213
    Usage:
837
 
    
 
1214
 
838
1215
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
839
1216
                       "org.freedesktop.DBus.Property."
840
1217
                       "EmitsChangedSignal": "false"})
842
1219
                           access="r")
843
1220
    def Property_dbus_property(self):
844
1221
        return dbus.Boolean(False)
845
 
    
 
1222
 
846
1223
    See also the DBusObjectWithAnnotations class.
847
1224
    """
848
 
    
 
1225
 
849
1226
    def decorator(func):
850
1227
        func._dbus_annotations = annotations
851
1228
        return func
852
 
    
 
1229
 
853
1230
    return decorator
854
1231
 
855
1232
 
873
1250
 
874
1251
class DBusObjectWithAnnotations(dbus.service.Object):
875
1252
    """A D-Bus object with annotations.
876
 
    
 
1253
 
877
1254
    Classes inheriting from this can use the dbus_annotations
878
1255
    decorator to add annotations to methods or signals.
879
1256
    """
880
 
    
 
1257
 
881
1258
    @staticmethod
882
1259
    def _is_dbus_thing(thing):
883
1260
        """Returns a function testing if an attribute is a D-Bus thing
884
 
        
 
1261
 
885
1262
        If called like _is_dbus_thing("method") it returns a function
886
1263
        suitable for use as predicate to inspect.getmembers().
887
1264
        """
888
1265
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
889
1266
                                   False)
890
 
    
 
1267
 
891
1268
    def _get_all_dbus_things(self, thing):
892
1269
        """Returns a generator of (name, attribute) pairs
893
1270
        """
896
1273
                for cls in self.__class__.__mro__
897
1274
                for name, athing in
898
1275
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
899
 
    
 
1276
 
900
1277
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
901
 
                         out_signature = "s",
902
 
                         path_keyword = 'object_path',
903
 
                         connection_keyword = 'connection')
 
1278
                         out_signature="s",
 
1279
                         path_keyword='object_path',
 
1280
                         connection_keyword='connection')
904
1281
    def Introspect(self, object_path, connection):
905
1282
        """Overloading of standard D-Bus method.
906
 
        
 
1283
 
907
1284
        Inserts annotation tags on methods and signals.
908
1285
        """
909
1286
        xmlstring = dbus.service.Object.Introspect(self, object_path,
910
1287
                                                   connection)
911
1288
        try:
912
1289
            document = xml.dom.minidom.parseString(xmlstring)
913
 
            
 
1290
 
914
1291
            for if_tag in document.getElementsByTagName("interface"):
915
1292
                # Add annotation tags
916
1293
                for typ in ("method", "signal"):
943
1320
                    if_tag.appendChild(ann_tag)
944
1321
                # Fix argument name for the Introspect method itself
945
1322
                if (if_tag.getAttribute("name")
946
 
                                == dbus.INTROSPECTABLE_IFACE):
 
1323
                    == dbus.INTROSPECTABLE_IFACE):
947
1324
                    for cn in if_tag.getElementsByTagName("method"):
948
1325
                        if cn.getAttribute("name") == "Introspect":
949
1326
                            for arg in cn.getElementsByTagName("arg"):
962
1339
 
963
1340
class DBusObjectWithProperties(DBusObjectWithAnnotations):
964
1341
    """A D-Bus object with properties.
965
 
    
 
1342
 
966
1343
    Classes inheriting from this can use the dbus_service_property
967
1344
    decorator to expose methods as D-Bus properties.  It exposes the
968
1345
    standard Get(), Set(), and GetAll() methods on the D-Bus.
969
1346
    """
970
 
    
 
1347
 
971
1348
    def _get_dbus_property(self, interface_name, property_name):
972
1349
        """Returns a bound method if one exists which is a D-Bus
973
1350
        property with the specified name and interface.
978
1355
                if (value._dbus_name == property_name
979
1356
                    and value._dbus_interface == interface_name):
980
1357
                    return value.__get__(self)
981
 
        
 
1358
 
982
1359
        # No such property
983
1360
        raise DBusPropertyNotFound("{}:{}.{}".format(
984
1361
            self.dbus_object_path, interface_name, property_name))
985
 
    
 
1362
 
986
1363
    @classmethod
987
1364
    def _get_all_interface_names(cls):
988
1365
        """Get a sequence of all interfaces supported by an object"""
991
1368
                                     for x in (inspect.getmro(cls))
992
1369
                                     for attr in dir(x))
993
1370
                if name is not None)
994
 
    
 
1371
 
995
1372
    @dbus.service.method(dbus.PROPERTIES_IFACE,
996
1373
                         in_signature="ss",
997
1374
                         out_signature="v")
1005
1382
        if not hasattr(value, "variant_level"):
1006
1383
            return value
1007
1384
        return type(value)(value, variant_level=value.variant_level+1)
1008
 
    
 
1385
 
1009
1386
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1010
1387
    def Set(self, interface_name, property_name, value):
1011
1388
        """Standard D-Bus property Set() method, see D-Bus standard.
1023
1400
            value = dbus.ByteArray(b''.join(chr(byte)
1024
1401
                                            for byte in value))
1025
1402
        prop(value)
1026
 
    
 
1403
 
1027
1404
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1028
1405
                         in_signature="s",
1029
1406
                         out_signature="a{sv}")
1030
1407
    def GetAll(self, interface_name):
1031
1408
        """Standard D-Bus property GetAll() method, see D-Bus
1032
1409
        standard.
1033
 
        
 
1410
 
1034
1411
        Note: Will not include properties with access="write".
1035
1412
        """
1036
1413
        properties = {}
1047
1424
                properties[name] = value
1048
1425
                continue
1049
1426
            properties[name] = type(value)(
1050
 
                value, variant_level = value.variant_level + 1)
 
1427
                value, variant_level=value.variant_level + 1)
1051
1428
        return dbus.Dictionary(properties, signature="sv")
1052
 
    
 
1429
 
1053
1430
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1054
1431
    def PropertiesChanged(self, interface_name, changed_properties,
1055
1432
                          invalidated_properties):
1057
1434
        standard.
1058
1435
        """
1059
1436
        pass
1060
 
    
 
1437
 
1061
1438
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1062
1439
                         out_signature="s",
1063
1440
                         path_keyword='object_path',
1064
1441
                         connection_keyword='connection')
1065
1442
    def Introspect(self, object_path, connection):
1066
1443
        """Overloading of standard D-Bus method.
1067
 
        
 
1444
 
1068
1445
        Inserts property tags and interface annotation tags.
1069
1446
        """
1070
1447
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1072
1449
                                                         connection)
1073
1450
        try:
1074
1451
            document = xml.dom.minidom.parseString(xmlstring)
1075
 
            
 
1452
 
1076
1453
            def make_tag(document, name, prop):
1077
1454
                e = document.createElement("property")
1078
1455
                e.setAttribute("name", name)
1079
1456
                e.setAttribute("type", prop._dbus_signature)
1080
1457
                e.setAttribute("access", prop._dbus_access)
1081
1458
                return e
1082
 
            
 
1459
 
1083
1460
            for if_tag in document.getElementsByTagName("interface"):
1084
1461
                # Add property tags
1085
1462
                for tag in (make_tag(document, name, prop)
1127
1504
                         exc_info=error)
1128
1505
        return xmlstring
1129
1506
 
 
1507
 
1130
1508
try:
1131
1509
    dbus.OBJECT_MANAGER_IFACE
1132
1510
except AttributeError:
1133
1511
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1134
1512
 
 
1513
 
1135
1514
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1136
1515
    """A D-Bus object with an ObjectManager.
1137
 
    
 
1516
 
1138
1517
    Classes inheriting from this exposes the standard
1139
1518
    GetManagedObjects call and the InterfacesAdded and
1140
1519
    InterfacesRemoved signals on the standard
1141
1520
    "org.freedesktop.DBus.ObjectManager" interface.
1142
 
    
 
1521
 
1143
1522
    Note: No signals are sent automatically; they must be sent
1144
1523
    manually.
1145
1524
    """
1146
1525
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1147
 
                         out_signature = "a{oa{sa{sv}}}")
 
1526
                         out_signature="a{oa{sa{sv}}}")
1148
1527
    def GetManagedObjects(self):
1149
1528
        """This function must be overridden"""
1150
1529
        raise NotImplementedError()
1151
 
    
 
1530
 
1152
1531
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1153
 
                         signature = "oa{sa{sv}}")
 
1532
                         signature="oa{sa{sv}}")
1154
1533
    def InterfacesAdded(self, object_path, interfaces_and_properties):
1155
1534
        pass
1156
 
    
1157
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1535
 
 
1536
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1158
1537
    def InterfacesRemoved(self, object_path, interfaces):
1159
1538
        pass
1160
 
    
 
1539
 
1161
1540
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1162
 
                         out_signature = "s",
1163
 
                         path_keyword = 'object_path',
1164
 
                         connection_keyword = 'connection')
 
1541
                         out_signature="s",
 
1542
                         path_keyword='object_path',
 
1543
                         connection_keyword='connection')
1165
1544
    def Introspect(self, object_path, connection):
1166
1545
        """Overloading of standard D-Bus method.
1167
 
        
 
1546
 
1168
1547
        Override return argument name of GetManagedObjects to be
1169
1548
        "objpath_interfaces_and_properties"
1170
1549
        """
1173
1552
                                                         connection)
1174
1553
        try:
1175
1554
            document = xml.dom.minidom.parseString(xmlstring)
1176
 
            
 
1555
 
1177
1556
            for if_tag in document.getElementsByTagName("interface"):
1178
1557
                # Fix argument name for the GetManagedObjects method
1179
1558
                if (if_tag.getAttribute("name")
1180
 
                                == dbus.OBJECT_MANAGER_IFACE):
 
1559
                    == dbus.OBJECT_MANAGER_IFACE):
1181
1560
                    for cn in if_tag.getElementsByTagName("method"):
1182
1561
                        if (cn.getAttribute("name")
1183
1562
                            == "GetManagedObjects"):
1193
1572
        except (AttributeError, xml.dom.DOMException,
1194
1573
                xml.parsers.expat.ExpatError) as error:
1195
1574
            logger.error("Failed to override Introspection method",
1196
 
                         exc_info = error)
 
1575
                         exc_info=error)
1197
1576
        return xmlstring
1198
1577
 
 
1578
 
1199
1579
def datetime_to_dbus(dt, variant_level=0):
1200
1580
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1201
1581
    if dt is None:
1202
 
        return dbus.String("", variant_level = variant_level)
 
1582
        return dbus.String("", variant_level=variant_level)
1203
1583
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1204
1584
 
1205
1585
 
1208
1588
    dbus.service.Object, it will add alternate D-Bus attributes with
1209
1589
    interface names according to the "alt_interface_names" mapping.
1210
1590
    Usage:
1211
 
    
 
1591
 
1212
1592
    @alternate_dbus_interfaces({"org.example.Interface":
1213
1593
                                    "net.example.AlternateInterface"})
1214
1594
    class SampleDBusObject(dbus.service.Object):
1215
1595
        @dbus.service.method("org.example.Interface")
1216
1596
        def SampleDBusMethod():
1217
1597
            pass
1218
 
    
 
1598
 
1219
1599
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1220
1600
    reachable via two interfaces: "org.example.Interface" and
1221
1601
    "net.example.AlternateInterface", the latter of which will have
1222
1602
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1223
1603
    "true", unless "deprecate" is passed with a False value.
1224
 
    
 
1604
 
1225
1605
    This works for methods and signals, and also for D-Bus properties
1226
1606
    (from DBusObjectWithProperties) and interfaces (from the
1227
1607
    dbus_interface_annotations decorator).
1228
1608
    """
1229
 
    
 
1609
 
1230
1610
    def wrapper(cls):
1231
1611
        for orig_interface_name, alt_interface_name in (
1232
1612
                alt_interface_names.items()):
1247
1627
                interface_names.add(alt_interface)
1248
1628
                # Is this a D-Bus signal?
1249
1629
                if getattr(attribute, "_dbus_is_signal", False):
 
1630
                    # Extract the original non-method undecorated
 
1631
                    # function by black magic
1250
1632
                    if sys.version_info.major == 2:
1251
 
                        # Extract the original non-method undecorated
1252
 
                        # function by black magic
1253
1633
                        nonmethod_func = (dict(
1254
1634
                            zip(attribute.func_code.co_freevars,
1255
1635
                                attribute.__closure__))
1256
1636
                                          ["func"].cell_contents)
1257
1637
                    else:
1258
 
                        nonmethod_func = attribute
 
1638
                        nonmethod_func = (dict(
 
1639
                            zip(attribute.__code__.co_freevars,
 
1640
                                attribute.__closure__))
 
1641
                                          ["func"].cell_contents)
1259
1642
                    # Create a new, but exactly alike, function
1260
1643
                    # object, and decorate it to be a new D-Bus signal
1261
1644
                    # with the alternate D-Bus interface name
1262
 
                    if sys.version_info.major == 2:
1263
 
                        new_function = types.FunctionType(
1264
 
                            nonmethod_func.func_code,
1265
 
                            nonmethod_func.func_globals,
1266
 
                            nonmethod_func.func_name,
1267
 
                            nonmethod_func.func_defaults,
1268
 
                            nonmethod_func.func_closure)
1269
 
                    else:
1270
 
                        new_function = types.FunctionType(
1271
 
                            nonmethod_func.__code__,
1272
 
                            nonmethod_func.__globals__,
1273
 
                            nonmethod_func.__name__,
1274
 
                            nonmethod_func.__defaults__,
1275
 
                            nonmethod_func.__closure__)
 
1645
                    new_function = copy_function(nonmethod_func)
1276
1646
                    new_function = (dbus.service.signal(
1277
1647
                        alt_interface,
1278
1648
                        attribute._dbus_signature)(new_function))
1282
1652
                            attribute._dbus_annotations)
1283
1653
                    except AttributeError:
1284
1654
                        pass
 
1655
 
1285
1656
                    # Define a creator of a function to call both the
1286
1657
                    # original and alternate functions, so both the
1287
1658
                    # original and alternate signals gets sent when
1290
1661
                        """This function is a scope container to pass
1291
1662
                        func1 and func2 to the "call_both" function
1292
1663
                        outside of its arguments"""
1293
 
                        
 
1664
 
1294
1665
                        @functools.wraps(func2)
1295
1666
                        def call_both(*args, **kwargs):
1296
1667
                            """This function will emit two D-Bus
1297
1668
                            signals by calling func1 and func2"""
1298
1669
                            func1(*args, **kwargs)
1299
1670
                            func2(*args, **kwargs)
1300
 
                        # Make wrapper function look like a D-Bus signal
 
1671
                        # Make wrapper function look like a D-Bus
 
1672
                        # signal
1301
1673
                        for name, attr in inspect.getmembers(func2):
1302
1674
                            if name.startswith("_dbus_"):
1303
1675
                                setattr(call_both, name, attr)
1304
 
                        
 
1676
 
1305
1677
                        return call_both
1306
1678
                    # Create the "call_both" function and add it to
1307
1679
                    # the class
1317
1689
                            alt_interface,
1318
1690
                            attribute._dbus_in_signature,
1319
1691
                            attribute._dbus_out_signature)
1320
 
                        (types.FunctionType(attribute.func_code,
1321
 
                                            attribute.func_globals,
1322
 
                                            attribute.func_name,
1323
 
                                            attribute.func_defaults,
1324
 
                                            attribute.func_closure)))
 
1692
                        (copy_function(attribute)))
1325
1693
                    # Copy annotations, if any
1326
1694
                    try:
1327
1695
                        attr[attrname]._dbus_annotations = dict(
1339
1707
                        attribute._dbus_access,
1340
1708
                        attribute._dbus_get_args_options
1341
1709
                        ["byte_arrays"])
1342
 
                                      (types.FunctionType(
1343
 
                                          attribute.func_code,
1344
 
                                          attribute.func_globals,
1345
 
                                          attribute.func_name,
1346
 
                                          attribute.func_defaults,
1347
 
                                          attribute.func_closure)))
 
1710
                                      (copy_function(attribute)))
1348
1711
                    # Copy annotations, if any
1349
1712
                    try:
1350
1713
                        attr[attrname]._dbus_annotations = dict(
1359
1722
                    # to the class.
1360
1723
                    attr[attrname] = (
1361
1724
                        dbus_interface_annotations(alt_interface)
1362
 
                        (types.FunctionType(attribute.func_code,
1363
 
                                            attribute.func_globals,
1364
 
                                            attribute.func_name,
1365
 
                                            attribute.func_defaults,
1366
 
                                            attribute.func_closure)))
 
1725
                        (copy_function(attribute)))
1367
1726
            if deprecate:
1368
1727
                # Deprecate all alternate interfaces
1369
 
                iname="_AlternateDBusNames_interface_annotation{}"
 
1728
                iname = "_AlternateDBusNames_interface_annotation{}"
1370
1729
                for interface_name in interface_names:
1371
 
                    
 
1730
 
1372
1731
                    @dbus_interface_annotations(interface_name)
1373
1732
                    def func(self):
1374
 
                        return { "org.freedesktop.DBus.Deprecated":
1375
 
                                 "true" }
 
1733
                        return {"org.freedesktop.DBus.Deprecated":
 
1734
                                "true"}
1376
1735
                    # Find an unused name
1377
1736
                    for aname in (iname.format(i)
1378
1737
                                  for i in itertools.count()):
1382
1741
            if interface_names:
1383
1742
                # Replace the class with a new subclass of it with
1384
1743
                # methods, signals, etc. as created above.
1385
 
                cls = type(b"{}Alternate".format(cls.__name__),
1386
 
                           (cls, ), attr)
 
1744
                if sys.version_info.major == 2:
 
1745
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1746
                               (cls, ), attr)
 
1747
                else:
 
1748
                    cls = type("{}Alternate".format(cls.__name__),
 
1749
                               (cls, ), attr)
1387
1750
        return cls
1388
 
    
 
1751
 
1389
1752
    return wrapper
1390
1753
 
1391
1754
 
1393
1756
                            "se.bsnet.fukt.Mandos"})
1394
1757
class ClientDBus(Client, DBusObjectWithProperties):
1395
1758
    """A Client class using D-Bus
1396
 
    
 
1759
 
1397
1760
    Attributes:
1398
1761
    dbus_object_path: dbus.ObjectPath
1399
1762
    bus: dbus.SystemBus()
1400
1763
    """
1401
 
    
 
1764
 
1402
1765
    runtime_expansions = (Client.runtime_expansions
1403
1766
                          + ("dbus_object_path", ))
1404
 
    
 
1767
 
1405
1768
    _interface = "se.recompile.Mandos.Client"
1406
 
    
 
1769
 
1407
1770
    # dbus.service.Object doesn't use super(), so we can't either.
1408
 
    
1409
 
    def __init__(self, bus = None, *args, **kwargs):
 
1771
 
 
1772
    def __init__(self, bus=None, *args, **kwargs):
1410
1773
        self.bus = bus
1411
1774
        Client.__init__(self, *args, **kwargs)
1412
1775
        # Only now, when this client is initialized, can it show up on
1418
1781
            "/clients/" + client_object_name)
1419
1782
        DBusObjectWithProperties.__init__(self, self.bus,
1420
1783
                                          self.dbus_object_path)
1421
 
    
 
1784
 
1422
1785
    def notifychangeproperty(transform_func, dbus_name,
1423
1786
                             type_func=lambda x: x,
1424
1787
                             variant_level=1,
1426
1789
                             _interface=_interface):
1427
1790
        """ Modify a variable so that it's a property which announces
1428
1791
        its changes to DBus.
1429
 
        
 
1792
 
1430
1793
        transform_fun: Function that takes a value and a variant_level
1431
1794
                       and transforms it to a D-Bus type.
1432
1795
        dbus_name: D-Bus name of the variable
1435
1798
        variant_level: D-Bus variant level.  Default: 1
1436
1799
        """
1437
1800
        attrname = "_{}".format(dbus_name)
1438
 
        
 
1801
 
1439
1802
        def setter(self, value):
1440
1803
            if hasattr(self, "dbus_object_path"):
1441
1804
                if (not hasattr(self, attrname) or
1448
1811
                    else:
1449
1812
                        dbus_value = transform_func(
1450
1813
                            type_func(value),
1451
 
                            variant_level = variant_level)
 
1814
                            variant_level=variant_level)
1452
1815
                        self.PropertyChanged(dbus.String(dbus_name),
1453
1816
                                             dbus_value)
1454
1817
                        self.PropertiesChanged(
1455
1818
                            _interface,
1456
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1457
 
                                              dbus_value }),
 
1819
                            dbus.Dictionary({dbus.String(dbus_name):
 
1820
                                             dbus_value}),
1458
1821
                            dbus.Array())
1459
1822
            setattr(self, attrname, value)
1460
 
        
 
1823
 
1461
1824
        return property(lambda self: getattr(self, attrname), setter)
1462
 
    
 
1825
 
1463
1826
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1464
1827
    approvals_pending = notifychangeproperty(dbus.Boolean,
1465
1828
                                             "ApprovalPending",
1466
 
                                             type_func = bool)
 
1829
                                             type_func=bool)
1467
1830
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1468
1831
    last_enabled = notifychangeproperty(datetime_to_dbus,
1469
1832
                                        "LastEnabled")
1470
1833
    checker = notifychangeproperty(
1471
1834
        dbus.Boolean, "CheckerRunning",
1472
 
        type_func = lambda checker: checker is not None)
 
1835
        type_func=lambda checker: checker is not None)
1473
1836
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1474
1837
                                           "LastCheckedOK")
1475
1838
    last_checker_status = notifychangeproperty(dbus.Int16,
1480
1843
                                               "ApprovedByDefault")
1481
1844
    approval_delay = notifychangeproperty(
1482
1845
        dbus.UInt64, "ApprovalDelay",
1483
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1846
        type_func=lambda td: td.total_seconds() * 1000)
1484
1847
    approval_duration = notifychangeproperty(
1485
1848
        dbus.UInt64, "ApprovalDuration",
1486
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1849
        type_func=lambda td: td.total_seconds() * 1000)
1487
1850
    host = notifychangeproperty(dbus.String, "Host")
1488
1851
    timeout = notifychangeproperty(
1489
1852
        dbus.UInt64, "Timeout",
1490
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1853
        type_func=lambda td: td.total_seconds() * 1000)
1491
1854
    extended_timeout = notifychangeproperty(
1492
1855
        dbus.UInt64, "ExtendedTimeout",
1493
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1856
        type_func=lambda td: td.total_seconds() * 1000)
1494
1857
    interval = notifychangeproperty(
1495
1858
        dbus.UInt64, "Interval",
1496
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1859
        type_func=lambda td: td.total_seconds() * 1000)
1497
1860
    checker_command = notifychangeproperty(dbus.String, "Checker")
1498
1861
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1499
1862
                                  invalidate_only=True)
1500
 
    
 
1863
 
1501
1864
    del notifychangeproperty
1502
 
    
 
1865
 
1503
1866
    def __del__(self, *args, **kwargs):
1504
1867
        try:
1505
1868
            self.remove_from_connection()
1508
1871
        if hasattr(DBusObjectWithProperties, "__del__"):
1509
1872
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1510
1873
        Client.__del__(self, *args, **kwargs)
1511
 
    
 
1874
 
1512
1875
    def checker_callback(self, source, condition,
1513
1876
                         connection, command, *args, **kwargs):
1514
1877
        ret = Client.checker_callback(self, source, condition,
1530
1893
                                      | self.last_checker_signal),
1531
1894
                                  dbus.String(command))
1532
1895
        return ret
1533
 
    
 
1896
 
1534
1897
    def start_checker(self, *args, **kwargs):
1535
1898
        old_checker_pid = getattr(self.checker, "pid", None)
1536
1899
        r = Client.start_checker(self, *args, **kwargs)
1540
1903
            # Emit D-Bus signal
1541
1904
            self.CheckerStarted(self.current_checker_command)
1542
1905
        return r
1543
 
    
 
1906
 
1544
1907
    def _reset_approved(self):
1545
1908
        self.approved = None
1546
1909
        return False
1547
 
    
 
1910
 
1548
1911
    def approve(self, value=True):
1549
1912
        self.approved = value
1550
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1551
 
                                * 1000), self._reset_approved)
 
1913
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1914
                             * 1000), self._reset_approved)
1552
1915
        self.send_changedstate()
1553
 
    
1554
 
    ## D-Bus methods, signals & properties
1555
 
    
1556
 
    ## Interfaces
1557
 
    
1558
 
    ## Signals
1559
 
    
 
1916
 
 
1917
    #  D-Bus methods, signals & properties
 
1918
 
 
1919
    #  Interfaces
 
1920
 
 
1921
    #  Signals
 
1922
 
1560
1923
    # CheckerCompleted - signal
1561
1924
    @dbus.service.signal(_interface, signature="nxs")
1562
1925
    def CheckerCompleted(self, exitcode, waitstatus, command):
1563
1926
        "D-Bus signal"
1564
1927
        pass
1565
 
    
 
1928
 
1566
1929
    # CheckerStarted - signal
1567
1930
    @dbus.service.signal(_interface, signature="s")
1568
1931
    def CheckerStarted(self, command):
1569
1932
        "D-Bus signal"
1570
1933
        pass
1571
 
    
 
1934
 
1572
1935
    # PropertyChanged - signal
1573
1936
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1574
1937
    @dbus.service.signal(_interface, signature="sv")
1575
1938
    def PropertyChanged(self, property, value):
1576
1939
        "D-Bus signal"
1577
1940
        pass
1578
 
    
 
1941
 
1579
1942
    # GotSecret - signal
1580
1943
    @dbus.service.signal(_interface)
1581
1944
    def GotSecret(self):
1584
1947
        server to mandos-client
1585
1948
        """
1586
1949
        pass
1587
 
    
 
1950
 
1588
1951
    # Rejected - signal
1589
1952
    @dbus.service.signal(_interface, signature="s")
1590
1953
    def Rejected(self, reason):
1591
1954
        "D-Bus signal"
1592
1955
        pass
1593
 
    
 
1956
 
1594
1957
    # NeedApproval - signal
1595
1958
    @dbus.service.signal(_interface, signature="tb")
1596
1959
    def NeedApproval(self, timeout, default):
1597
1960
        "D-Bus signal"
1598
1961
        return self.need_approval()
1599
 
    
1600
 
    ## Methods
1601
 
    
 
1962
 
 
1963
    #  Methods
 
1964
 
1602
1965
    # Approve - method
1603
1966
    @dbus.service.method(_interface, in_signature="b")
1604
1967
    def Approve(self, value):
1605
1968
        self.approve(value)
1606
 
    
 
1969
 
1607
1970
    # CheckedOK - method
1608
1971
    @dbus.service.method(_interface)
1609
1972
    def CheckedOK(self):
1610
1973
        self.checked_ok()
1611
 
    
 
1974
 
1612
1975
    # Enable - method
1613
1976
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1614
1977
    @dbus.service.method(_interface)
1615
1978
    def Enable(self):
1616
1979
        "D-Bus method"
1617
1980
        self.enable()
1618
 
    
 
1981
 
1619
1982
    # StartChecker - method
1620
1983
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1621
1984
    @dbus.service.method(_interface)
1622
1985
    def StartChecker(self):
1623
1986
        "D-Bus method"
1624
1987
        self.start_checker()
1625
 
    
 
1988
 
1626
1989
    # Disable - method
1627
1990
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1628
1991
    @dbus.service.method(_interface)
1629
1992
    def Disable(self):
1630
1993
        "D-Bus method"
1631
1994
        self.disable()
1632
 
    
 
1995
 
1633
1996
    # StopChecker - method
1634
1997
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1635
1998
    @dbus.service.method(_interface)
1636
1999
    def StopChecker(self):
1637
2000
        self.stop_checker()
1638
 
    
1639
 
    ## Properties
1640
 
    
 
2001
 
 
2002
    #  Properties
 
2003
 
1641
2004
    # ApprovalPending - property
1642
2005
    @dbus_service_property(_interface, signature="b", access="read")
1643
2006
    def ApprovalPending_dbus_property(self):
1644
2007
        return dbus.Boolean(bool(self.approvals_pending))
1645
 
    
 
2008
 
1646
2009
    # ApprovedByDefault - property
1647
2010
    @dbus_service_property(_interface,
1648
2011
                           signature="b",
1651
2014
        if value is None:       # get
1652
2015
            return dbus.Boolean(self.approved_by_default)
1653
2016
        self.approved_by_default = bool(value)
1654
 
    
 
2017
 
1655
2018
    # ApprovalDelay - property
1656
2019
    @dbus_service_property(_interface,
1657
2020
                           signature="t",
1661
2024
            return dbus.UInt64(self.approval_delay.total_seconds()
1662
2025
                               * 1000)
1663
2026
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1664
 
    
 
2027
 
1665
2028
    # ApprovalDuration - property
1666
2029
    @dbus_service_property(_interface,
1667
2030
                           signature="t",
1671
2034
            return dbus.UInt64(self.approval_duration.total_seconds()
1672
2035
                               * 1000)
1673
2036
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1674
 
    
 
2037
 
1675
2038
    # Name - property
1676
2039
    @dbus_annotations(
1677
2040
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1678
2041
    @dbus_service_property(_interface, signature="s", access="read")
1679
2042
    def Name_dbus_property(self):
1680
2043
        return dbus.String(self.name)
1681
 
    
 
2044
 
 
2045
    # KeyID - property
 
2046
    @dbus_annotations(
 
2047
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
2048
    @dbus_service_property(_interface, signature="s", access="read")
 
2049
    def KeyID_dbus_property(self):
 
2050
        return dbus.String(self.key_id)
 
2051
 
1682
2052
    # Fingerprint - property
1683
2053
    @dbus_annotations(
1684
2054
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1685
2055
    @dbus_service_property(_interface, signature="s", access="read")
1686
2056
    def Fingerprint_dbus_property(self):
1687
2057
        return dbus.String(self.fingerprint)
1688
 
    
 
2058
 
1689
2059
    # Host - property
1690
2060
    @dbus_service_property(_interface,
1691
2061
                           signature="s",
1694
2064
        if value is None:       # get
1695
2065
            return dbus.String(self.host)
1696
2066
        self.host = str(value)
1697
 
    
 
2067
 
1698
2068
    # Created - property
1699
2069
    @dbus_annotations(
1700
2070
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1701
2071
    @dbus_service_property(_interface, signature="s", access="read")
1702
2072
    def Created_dbus_property(self):
1703
2073
        return datetime_to_dbus(self.created)
1704
 
    
 
2074
 
1705
2075
    # LastEnabled - property
1706
2076
    @dbus_service_property(_interface, signature="s", access="read")
1707
2077
    def LastEnabled_dbus_property(self):
1708
2078
        return datetime_to_dbus(self.last_enabled)
1709
 
    
 
2079
 
1710
2080
    # Enabled - property
1711
2081
    @dbus_service_property(_interface,
1712
2082
                           signature="b",
1718
2088
            self.enable()
1719
2089
        else:
1720
2090
            self.disable()
1721
 
    
 
2091
 
1722
2092
    # LastCheckedOK - property
1723
2093
    @dbus_service_property(_interface,
1724
2094
                           signature="s",
1728
2098
            self.checked_ok()
1729
2099
            return
1730
2100
        return datetime_to_dbus(self.last_checked_ok)
1731
 
    
 
2101
 
1732
2102
    # LastCheckerStatus - property
1733
2103
    @dbus_service_property(_interface, signature="n", access="read")
1734
2104
    def LastCheckerStatus_dbus_property(self):
1735
2105
        return dbus.Int16(self.last_checker_status)
1736
 
    
 
2106
 
1737
2107
    # Expires - property
1738
2108
    @dbus_service_property(_interface, signature="s", access="read")
1739
2109
    def Expires_dbus_property(self):
1740
2110
        return datetime_to_dbus(self.expires)
1741
 
    
 
2111
 
1742
2112
    # LastApprovalRequest - property
1743
2113
    @dbus_service_property(_interface, signature="s", access="read")
1744
2114
    def LastApprovalRequest_dbus_property(self):
1745
2115
        return datetime_to_dbus(self.last_approval_request)
1746
 
    
 
2116
 
1747
2117
    # Timeout - property
1748
2118
    @dbus_service_property(_interface,
1749
2119
                           signature="t",
1764
2134
                if (getattr(self, "disable_initiator_tag", None)
1765
2135
                    is None):
1766
2136
                    return
1767
 
                gobject.source_remove(self.disable_initiator_tag)
1768
 
                self.disable_initiator_tag = gobject.timeout_add(
 
2137
                GLib.source_remove(self.disable_initiator_tag)
 
2138
                self.disable_initiator_tag = GLib.timeout_add(
1769
2139
                    int((self.expires - now).total_seconds() * 1000),
1770
2140
                    self.disable)
1771
 
    
 
2141
 
1772
2142
    # ExtendedTimeout - property
1773
2143
    @dbus_service_property(_interface,
1774
2144
                           signature="t",
1778
2148
            return dbus.UInt64(self.extended_timeout.total_seconds()
1779
2149
                               * 1000)
1780
2150
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1781
 
    
 
2151
 
1782
2152
    # Interval - property
1783
2153
    @dbus_service_property(_interface,
1784
2154
                           signature="t",
1791
2161
            return
1792
2162
        if self.enabled:
1793
2163
            # Reschedule checker run
1794
 
            gobject.source_remove(self.checker_initiator_tag)
1795
 
            self.checker_initiator_tag = gobject.timeout_add(
 
2164
            GLib.source_remove(self.checker_initiator_tag)
 
2165
            self.checker_initiator_tag = GLib.timeout_add(
1796
2166
                value, self.start_checker)
1797
 
            self.start_checker() # Start one now, too
1798
 
    
 
2167
            self.start_checker()  # Start one now, too
 
2168
 
1799
2169
    # Checker - property
1800
2170
    @dbus_service_property(_interface,
1801
2171
                           signature="s",
1804
2174
        if value is None:       # get
1805
2175
            return dbus.String(self.checker_command)
1806
2176
        self.checker_command = str(value)
1807
 
    
 
2177
 
1808
2178
    # CheckerRunning - property
1809
2179
    @dbus_service_property(_interface,
1810
2180
                           signature="b",
1816
2186
            self.start_checker()
1817
2187
        else:
1818
2188
            self.stop_checker()
1819
 
    
 
2189
 
1820
2190
    # ObjectPath - property
1821
2191
    @dbus_annotations(
1822
2192
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
1823
2193
         "org.freedesktop.DBus.Deprecated": "true"})
1824
2194
    @dbus_service_property(_interface, signature="o", access="read")
1825
2195
    def ObjectPath_dbus_property(self):
1826
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1827
 
    
 
2196
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2197
 
1828
2198
    # Secret = property
1829
2199
    @dbus_annotations(
1830
2200
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
1835
2205
                           byte_arrays=True)
1836
2206
    def Secret_dbus_property(self, value):
1837
2207
        self.secret = bytes(value)
1838
 
    
 
2208
 
1839
2209
    del _interface
1840
2210
 
1841
2211
 
1842
2212
class ProxyClient(object):
1843
 
    def __init__(self, child_pipe, fpr, address):
 
2213
    def __init__(self, child_pipe, key_id, fpr, address):
1844
2214
        self._pipe = child_pipe
1845
 
        self._pipe.send(('init', fpr, address))
 
2215
        self._pipe.send(('init', key_id, fpr, address))
1846
2216
        if not self._pipe.recv():
1847
 
            raise KeyError(fpr)
1848
 
    
 
2217
            raise KeyError(key_id or fpr)
 
2218
 
1849
2219
    def __getattribute__(self, name):
1850
2220
        if name == '_pipe':
1851
2221
            return super(ProxyClient, self).__getattribute__(name)
1854
2224
        if data[0] == 'data':
1855
2225
            return data[1]
1856
2226
        if data[0] == 'function':
1857
 
            
 
2227
 
1858
2228
            def func(*args, **kwargs):
1859
2229
                self._pipe.send(('funcall', name, args, kwargs))
1860
2230
                return self._pipe.recv()[1]
1861
 
            
 
2231
 
1862
2232
            return func
1863
 
    
 
2233
 
1864
2234
    def __setattr__(self, name, value):
1865
2235
        if name == '_pipe':
1866
2236
            return super(ProxyClient, self).__setattr__(name, value)
1869
2239
 
1870
2240
class ClientHandler(socketserver.BaseRequestHandler, object):
1871
2241
    """A class to handle client connections.
1872
 
    
 
2242
 
1873
2243
    Instantiated once for each connection to handle it.
1874
2244
    Note: This will run in its own forked process."""
1875
 
    
 
2245
 
1876
2246
    def handle(self):
1877
2247
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1878
2248
            logger.info("TCP connection from: %s",
1879
2249
                        str(self.client_address))
1880
2250
            logger.debug("Pipe FD: %d",
1881
2251
                         self.server.child_pipe.fileno())
1882
 
            
1883
 
            session = gnutls.connection.ClientSession(
1884
 
                self.request, gnutls.connection .X509Credentials())
1885
 
            
1886
 
            # Note: gnutls.connection.X509Credentials is really a
1887
 
            # generic GnuTLS certificate credentials object so long as
1888
 
            # no X.509 keys are added to it.  Therefore, we can use it
1889
 
            # here despite using OpenPGP certificates.
1890
 
            
1891
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1892
 
            #                      "+AES-256-CBC", "+SHA1",
1893
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1894
 
            #                      "+DHE-DSS"))
 
2252
 
 
2253
            session = gnutls.ClientSession(self.request)
 
2254
 
 
2255
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2256
            #                       "+AES-256-CBC", "+SHA1",
 
2257
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
 
2258
            #                       "+DHE-DSS"))
1895
2259
            # Use a fallback default, since this MUST be set.
1896
2260
            priority = self.server.gnutls_priority
1897
2261
            if priority is None:
1898
2262
                priority = "NORMAL"
1899
 
            gnutls.library.functions.gnutls_priority_set_direct(
1900
 
                session._c_object, priority, None)
1901
 
            
 
2263
            gnutls.priority_set_direct(session._c_object,
 
2264
                                       priority.encode("utf-8"),
 
2265
                                       None)
 
2266
 
1902
2267
            # Start communication using the Mandos protocol
1903
2268
            # Get protocol number
1904
2269
            line = self.request.makefile().readline()
1909
2274
            except (ValueError, IndexError, RuntimeError) as error:
1910
2275
                logger.error("Unknown protocol version: %s", error)
1911
2276
                return
1912
 
            
 
2277
 
1913
2278
            # Start GnuTLS connection
1914
2279
            try:
1915
2280
                session.handshake()
1916
 
            except gnutls.errors.GNUTLSError as error:
 
2281
            except gnutls.Error as error:
1917
2282
                logger.warning("Handshake failed: %s", error)
1918
2283
                # Do not run session.bye() here: the session is not
1919
2284
                # established.  Just abandon the request.
1920
2285
                return
1921
2286
            logger.debug("Handshake succeeded")
1922
 
            
 
2287
 
1923
2288
            approval_required = False
1924
2289
            try:
1925
 
                try:
1926
 
                    fpr = self.fingerprint(
1927
 
                        self.peer_certificate(session))
1928
 
                except (TypeError,
1929
 
                        gnutls.errors.GNUTLSError) as error:
1930
 
                    logger.warning("Bad certificate: %s", error)
1931
 
                    return
1932
 
                logger.debug("Fingerprint: %s", fpr)
1933
 
                
1934
 
                try:
1935
 
                    client = ProxyClient(child_pipe, fpr,
 
2290
                if gnutls.has_rawpk:
 
2291
                    fpr = b""
 
2292
                    try:
 
2293
                        key_id = self.key_id(
 
2294
                            self.peer_certificate(session))
 
2295
                    except (TypeError, gnutls.Error) as error:
 
2296
                        logger.warning("Bad certificate: %s", error)
 
2297
                        return
 
2298
                    logger.debug("Key ID: %s", key_id)
 
2299
 
 
2300
                else:
 
2301
                    key_id = b""
 
2302
                    try:
 
2303
                        fpr = self.fingerprint(
 
2304
                            self.peer_certificate(session))
 
2305
                    except (TypeError, gnutls.Error) as error:
 
2306
                        logger.warning("Bad certificate: %s", error)
 
2307
                        return
 
2308
                    logger.debug("Fingerprint: %s", fpr)
 
2309
 
 
2310
                try:
 
2311
                    client = ProxyClient(child_pipe, key_id, fpr,
1936
2312
                                         self.client_address)
1937
2313
                except KeyError:
1938
2314
                    return
1939
 
                
 
2315
 
1940
2316
                if client.approval_delay:
1941
2317
                    delay = client.approval_delay
1942
2318
                    client.approvals_pending += 1
1943
2319
                    approval_required = True
1944
 
                
 
2320
 
1945
2321
                while True:
1946
2322
                    if not client.enabled:
1947
2323
                        logger.info("Client %s is disabled",
1950
2326
                            # Emit D-Bus signal
1951
2327
                            client.Rejected("Disabled")
1952
2328
                        return
1953
 
                    
 
2329
 
1954
2330
                    if client.approved or not client.approval_delay:
1955
 
                        #We are approved or approval is disabled
 
2331
                        # We are approved or approval is disabled
1956
2332
                        break
1957
2333
                    elif client.approved is None:
1958
2334
                        logger.info("Client %s needs approval",
1969
2345
                            # Emit D-Bus signal
1970
2346
                            client.Rejected("Denied")
1971
2347
                        return
1972
 
                    
1973
 
                    #wait until timeout or approved
 
2348
 
 
2349
                    # wait until timeout or approved
1974
2350
                    time = datetime.datetime.now()
1975
2351
                    client.changedstate.acquire()
1976
2352
                    client.changedstate.wait(delay.total_seconds())
1989
2365
                            break
1990
2366
                    else:
1991
2367
                        delay -= time2 - time
1992
 
                
1993
 
                sent_size = 0
1994
 
                while sent_size < len(client.secret):
1995
 
                    try:
1996
 
                        sent = session.send(client.secret[sent_size:])
1997
 
                    except gnutls.errors.GNUTLSError as error:
1998
 
                        logger.warning("gnutls send failed",
1999
 
                                       exc_info=error)
2000
 
                        return
2001
 
                    logger.debug("Sent: %d, remaining: %d", sent,
2002
 
                                 len(client.secret) - (sent_size
2003
 
                                                       + sent))
2004
 
                    sent_size += sent
2005
 
                
 
2368
 
 
2369
                try:
 
2370
                    session.send(client.secret)
 
2371
                except gnutls.Error as error:
 
2372
                    logger.warning("gnutls send failed",
 
2373
                                   exc_info=error)
 
2374
                    return
 
2375
 
2006
2376
                logger.info("Sending secret to %s", client.name)
2007
2377
                # bump the timeout using extended_timeout
2008
2378
                client.bump_timeout(client.extended_timeout)
2009
2379
                if self.server.use_dbus:
2010
2380
                    # Emit D-Bus signal
2011
2381
                    client.GotSecret()
2012
 
            
 
2382
 
2013
2383
            finally:
2014
2384
                if approval_required:
2015
2385
                    client.approvals_pending -= 1
2016
2386
                try:
2017
2387
                    session.bye()
2018
 
                except gnutls.errors.GNUTLSError as error:
 
2388
                except gnutls.Error as error:
2019
2389
                    logger.warning("GnuTLS bye failed",
2020
2390
                                   exc_info=error)
2021
 
    
 
2391
 
2022
2392
    @staticmethod
2023
2393
    def peer_certificate(session):
2024
 
        "Return the peer's OpenPGP certificate as a bytestring"
2025
 
        # If not an OpenPGP certificate...
2026
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
2027
 
                session._c_object)
2028
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
2029
 
            # ...do the normal thing
2030
 
            return session.peer_certificate
 
2394
        "Return the peer's certificate as a bytestring"
 
2395
        try:
 
2396
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2397
                                                     gnutls.CTYPE_PEERS)
 
2398
        except AttributeError:
 
2399
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2400
        if gnutls.has_rawpk:
 
2401
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
 
2402
        else:
 
2403
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
 
2404
        # If not a valid certificate type...
 
2405
        if cert_type not in valid_cert_types:
 
2406
            logger.info("Cert type %r not in %r", cert_type,
 
2407
                        valid_cert_types)
 
2408
            # ...return invalid data
 
2409
            return b""
2031
2410
        list_size = ctypes.c_uint(1)
2032
 
        cert_list = (gnutls.library.functions
2033
 
                     .gnutls_certificate_get_peers
 
2411
        cert_list = (gnutls.certificate_get_peers
2034
2412
                     (session._c_object, ctypes.byref(list_size)))
2035
2413
        if not bool(cert_list) and list_size.value != 0:
2036
 
            raise gnutls.errors.GNUTLSError("error getting peer"
2037
 
                                            " certificate")
 
2414
            raise gnutls.Error("error getting peer certificate")
2038
2415
        if list_size.value == 0:
2039
2416
            return None
2040
2417
        cert = cert_list[0]
2041
2418
        return ctypes.string_at(cert.data, cert.size)
2042
 
    
 
2419
 
 
2420
    @staticmethod
 
2421
    def key_id(certificate):
 
2422
        "Convert a certificate bytestring to a hexdigit key ID"
 
2423
        # New GnuTLS "datum" with the public key
 
2424
        datum = gnutls.datum_t(
 
2425
            ctypes.cast(ctypes.c_char_p(certificate),
 
2426
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2427
            ctypes.c_uint(len(certificate)))
 
2428
        # XXX all these need to be created in the gnutls "module"
 
2429
        # New empty GnuTLS certificate
 
2430
        pubkey = gnutls.pubkey_t()
 
2431
        gnutls.pubkey_init(ctypes.byref(pubkey))
 
2432
        # Import the raw public key into the certificate
 
2433
        gnutls.pubkey_import(pubkey,
 
2434
                             ctypes.byref(datum),
 
2435
                             gnutls.X509_FMT_DER)
 
2436
        # New buffer for the key ID
 
2437
        buf = ctypes.create_string_buffer(32)
 
2438
        buf_len = ctypes.c_size_t(len(buf))
 
2439
        # Get the key ID from the raw public key into the buffer
 
2440
        gnutls.pubkey_get_key_id(pubkey,
 
2441
                                 gnutls.KEYID_USE_SHA256,
 
2442
                                 ctypes.cast(ctypes.byref(buf),
 
2443
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2444
                                 ctypes.byref(buf_len))
 
2445
        # Deinit the certificate
 
2446
        gnutls.pubkey_deinit(pubkey)
 
2447
 
 
2448
        # Convert the buffer to a Python bytestring
 
2449
        key_id = ctypes.string_at(buf, buf_len.value)
 
2450
        # Convert the bytestring to hexadecimal notation
 
2451
        hex_key_id = binascii.hexlify(key_id).upper()
 
2452
        return hex_key_id
 
2453
 
2043
2454
    @staticmethod
2044
2455
    def fingerprint(openpgp):
2045
2456
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2046
2457
        # New GnuTLS "datum" with the OpenPGP public key
2047
 
        datum = gnutls.library.types.gnutls_datum_t(
 
2458
        datum = gnutls.datum_t(
2048
2459
            ctypes.cast(ctypes.c_char_p(openpgp),
2049
2460
                        ctypes.POINTER(ctypes.c_ubyte)),
2050
2461
            ctypes.c_uint(len(openpgp)))
2051
2462
        # New empty GnuTLS certificate
2052
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
2053
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
2054
 
            ctypes.byref(crt))
 
2463
        crt = gnutls.openpgp_crt_t()
 
2464
        gnutls.openpgp_crt_init(ctypes.byref(crt))
2055
2465
        # Import the OpenPGP public key into the certificate
2056
 
        gnutls.library.functions.gnutls_openpgp_crt_import(
2057
 
            crt, ctypes.byref(datum),
2058
 
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
2466
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2467
                                  gnutls.OPENPGP_FMT_RAW)
2059
2468
        # Verify the self signature in the key
2060
2469
        crtverify = ctypes.c_uint()
2061
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
2062
 
            crt, 0, ctypes.byref(crtverify))
 
2470
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2471
                                       ctypes.byref(crtverify))
2063
2472
        if crtverify.value != 0:
2064
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2065
 
            raise gnutls.errors.CertificateSecurityError(
2066
 
                "Verify failed")
 
2473
            gnutls.openpgp_crt_deinit(crt)
 
2474
            raise gnutls.CertificateSecurityError(code
 
2475
                                                  =crtverify.value)
2067
2476
        # New buffer for the fingerprint
2068
2477
        buf = ctypes.create_string_buffer(20)
2069
2478
        buf_len = ctypes.c_size_t()
2070
2479
        # Get the fingerprint from the certificate into the buffer
2071
 
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
2072
 
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
2480
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2481
                                           ctypes.byref(buf_len))
2073
2482
        # Deinit the certificate
2074
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2483
        gnutls.openpgp_crt_deinit(crt)
2075
2484
        # Convert the buffer to a Python bytestring
2076
2485
        fpr = ctypes.string_at(buf, buf_len.value)
2077
2486
        # Convert the bytestring to hexadecimal notation
2081
2490
 
2082
2491
class MultiprocessingMixIn(object):
2083
2492
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2084
 
    
 
2493
 
2085
2494
    def sub_process_main(self, request, address):
2086
2495
        try:
2087
2496
            self.finish_request(request, address)
2088
2497
        except Exception:
2089
2498
            self.handle_error(request, address)
2090
2499
        self.close_request(request)
2091
 
    
 
2500
 
2092
2501
    def process_request(self, request, address):
2093
2502
        """Start a new process to process the request."""
2094
 
        proc = multiprocessing.Process(target = self.sub_process_main,
2095
 
                                       args = (request, address))
 
2503
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2504
                                       args=(request, address))
2096
2505
        proc.start()
2097
2506
        return proc
2098
2507
 
2099
2508
 
2100
2509
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2101
2510
    """ adds a pipe to the MixIn """
2102
 
    
 
2511
 
2103
2512
    def process_request(self, request, client_address):
2104
2513
        """Overrides and wraps the original process_request().
2105
 
        
 
2514
 
2106
2515
        This function creates a new pipe in self.pipe
2107
2516
        """
2108
2517
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
2109
 
        
 
2518
 
2110
2519
        proc = MultiprocessingMixIn.process_request(self, request,
2111
2520
                                                    client_address)
2112
2521
        self.child_pipe.close()
2113
2522
        self.add_pipe(parent_pipe, proc)
2114
 
    
 
2523
 
2115
2524
    def add_pipe(self, parent_pipe, proc):
2116
2525
        """Dummy function; override as necessary"""
2117
2526
        raise NotImplementedError()
2120
2529
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2121
2530
                     socketserver.TCPServer, object):
2122
2531
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2123
 
    
 
2532
 
2124
2533
    Attributes:
2125
2534
        enabled:        Boolean; whether this server is activated yet
2126
2535
        interface:      None or a network interface name (string)
2127
2536
        use_ipv6:       Boolean; to use IPv6 or not
2128
2537
    """
2129
 
    
 
2538
 
2130
2539
    def __init__(self, server_address, RequestHandlerClass,
2131
2540
                 interface=None,
2132
2541
                 use_ipv6=True,
2142
2551
            self.socketfd = socketfd
2143
2552
            # Save the original socket.socket() function
2144
2553
            self.socket_socket = socket.socket
 
2554
 
2145
2555
            # To implement --socket, we monkey patch socket.socket.
2146
 
            # 
 
2556
            #
2147
2557
            # (When socketserver.TCPServer is a new-style class, we
2148
2558
            # could make self.socket into a property instead of monkey
2149
2559
            # patching socket.socket.)
2150
 
            # 
 
2560
            #
2151
2561
            # Create a one-time-only replacement for socket.socket()
2152
2562
            @functools.wraps(socket.socket)
2153
2563
            def socket_wrapper(*args, **kwargs):
2165
2575
        # socket_wrapper(), if socketfd was set.
2166
2576
        socketserver.TCPServer.__init__(self, server_address,
2167
2577
                                        RequestHandlerClass)
2168
 
    
 
2578
 
2169
2579
    def server_bind(self):
2170
2580
        """This overrides the normal server_bind() function
2171
2581
        to bind to an interface if one was specified, and also NOT to
2172
2582
        bind to an address or port if they were not specified."""
 
2583
        global SO_BINDTODEVICE
2173
2584
        if self.interface is not None:
2174
2585
            if SO_BINDTODEVICE is None:
2175
 
                logger.error("SO_BINDTODEVICE does not exist;"
2176
 
                             " cannot bind to interface %s",
2177
 
                             self.interface)
2178
 
            else:
2179
 
                try:
2180
 
                    self.socket.setsockopt(
2181
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2182
 
                        (self.interface + "\0").encode("utf-8"))
2183
 
                except socket.error as error:
2184
 
                    if error.errno == errno.EPERM:
2185
 
                        logger.error("No permission to bind to"
2186
 
                                     " interface %s", self.interface)
2187
 
                    elif error.errno == errno.ENOPROTOOPT:
2188
 
                        logger.error("SO_BINDTODEVICE not available;"
2189
 
                                     " cannot bind to interface %s",
2190
 
                                     self.interface)
2191
 
                    elif error.errno == errno.ENODEV:
2192
 
                        logger.error("Interface %s does not exist,"
2193
 
                                     " cannot bind", self.interface)
2194
 
                    else:
2195
 
                        raise
 
2586
                # Fall back to a hard-coded value which seems to be
 
2587
                # common enough.
 
2588
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2589
                SO_BINDTODEVICE = 25
 
2590
            try:
 
2591
                self.socket.setsockopt(
 
2592
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2593
                    (self.interface + "\0").encode("utf-8"))
 
2594
            except socket.error as error:
 
2595
                if error.errno == errno.EPERM:
 
2596
                    logger.error("No permission to bind to"
 
2597
                                 " interface %s", self.interface)
 
2598
                elif error.errno == errno.ENOPROTOOPT:
 
2599
                    logger.error("SO_BINDTODEVICE not available;"
 
2600
                                 " cannot bind to interface %s",
 
2601
                                 self.interface)
 
2602
                elif error.errno == errno.ENODEV:
 
2603
                    logger.error("Interface %s does not exist,"
 
2604
                                 " cannot bind", self.interface)
 
2605
                else:
 
2606
                    raise
2196
2607
        # Only bind(2) the socket if we really need to.
2197
2608
        if self.server_address[0] or self.server_address[1]:
 
2609
            if self.server_address[1]:
 
2610
                self.allow_reuse_address = True
2198
2611
            if not self.server_address[0]:
2199
2612
                if self.address_family == socket.AF_INET6:
2200
 
                    any_address = "::" # in6addr_any
 
2613
                    any_address = "::"  # in6addr_any
2201
2614
                else:
2202
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
2615
                    any_address = "0.0.0.0"  # INADDR_ANY
2203
2616
                self.server_address = (any_address,
2204
2617
                                       self.server_address[1])
2205
2618
            elif not self.server_address[1]:
2215
2628
 
2216
2629
class MandosServer(IPv6_TCPServer):
2217
2630
    """Mandos server.
2218
 
    
 
2631
 
2219
2632
    Attributes:
2220
2633
        clients:        set of Client objects
2221
2634
        gnutls_priority GnuTLS priority string
2222
2635
        use_dbus:       Boolean; to emit D-Bus signals or not
2223
 
    
2224
 
    Assumes a gobject.MainLoop event loop.
 
2636
 
 
2637
    Assumes a GLib.MainLoop event loop.
2225
2638
    """
2226
 
    
 
2639
 
2227
2640
    def __init__(self, server_address, RequestHandlerClass,
2228
2641
                 interface=None,
2229
2642
                 use_ipv6=True,
2239
2652
        self.gnutls_priority = gnutls_priority
2240
2653
        IPv6_TCPServer.__init__(self, server_address,
2241
2654
                                RequestHandlerClass,
2242
 
                                interface = interface,
2243
 
                                use_ipv6 = use_ipv6,
2244
 
                                socketfd = socketfd)
2245
 
    
 
2655
                                interface=interface,
 
2656
                                use_ipv6=use_ipv6,
 
2657
                                socketfd=socketfd)
 
2658
 
2246
2659
    def server_activate(self):
2247
2660
        if self.enabled:
2248
2661
            return socketserver.TCPServer.server_activate(self)
2249
 
    
 
2662
 
2250
2663
    def enable(self):
2251
2664
        self.enabled = True
2252
 
    
 
2665
 
2253
2666
    def add_pipe(self, parent_pipe, proc):
2254
2667
        # Call "handle_ipc" for both data and EOF events
2255
 
        gobject.io_add_watch(
 
2668
        GLib.io_add_watch(
2256
2669
            parent_pipe.fileno(),
2257
 
            gobject.IO_IN | gobject.IO_HUP,
 
2670
            GLib.IO_IN | GLib.IO_HUP,
2258
2671
            functools.partial(self.handle_ipc,
2259
 
                              parent_pipe = parent_pipe,
2260
 
                              proc = proc))
2261
 
    
 
2672
                              parent_pipe=parent_pipe,
 
2673
                              proc=proc))
 
2674
 
2262
2675
    def handle_ipc(self, source, condition,
2263
2676
                   parent_pipe=None,
2264
 
                   proc = None,
 
2677
                   proc=None,
2265
2678
                   client_object=None):
2266
2679
        # error, or the other end of multiprocessing.Pipe has closed
2267
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2680
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2268
2681
            # Wait for other process to exit
2269
2682
            proc.join()
2270
2683
            return False
2271
 
        
 
2684
 
2272
2685
        # Read a request from the child
2273
2686
        request = parent_pipe.recv()
2274
2687
        command = request[0]
2275
 
        
 
2688
 
2276
2689
        if command == 'init':
2277
 
            fpr = request[1]
2278
 
            address = request[2]
2279
 
            
2280
 
            for c in self.clients.itervalues():
2281
 
                if c.fingerprint == fpr:
 
2690
            key_id = request[1].decode("ascii")
 
2691
            fpr = request[2].decode("ascii")
 
2692
            address = request[3]
 
2693
 
 
2694
            for c in self.clients.values():
 
2695
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
 
2696
                    continue
 
2697
                if key_id and c.key_id == key_id:
 
2698
                    client = c
 
2699
                    break
 
2700
                if fpr and c.fingerprint == fpr:
2282
2701
                    client = c
2283
2702
                    break
2284
2703
            else:
2285
 
                logger.info("Client not found for fingerprint: %s, ad"
2286
 
                            "dress: %s", fpr, address)
 
2704
                logger.info("Client not found for key ID: %s, address"
 
2705
                            ": %s", key_id or fpr, address)
2287
2706
                if self.use_dbus:
2288
2707
                    # Emit D-Bus signal
2289
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
2708
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2290
2709
                                                       address[0])
2291
2710
                parent_pipe.send(False)
2292
2711
                return False
2293
 
            
2294
 
            gobject.io_add_watch(
 
2712
 
 
2713
            GLib.io_add_watch(
2295
2714
                parent_pipe.fileno(),
2296
 
                gobject.IO_IN | gobject.IO_HUP,
 
2715
                GLib.IO_IN | GLib.IO_HUP,
2297
2716
                functools.partial(self.handle_ipc,
2298
 
                                  parent_pipe = parent_pipe,
2299
 
                                  proc = proc,
2300
 
                                  client_object = client))
 
2717
                                  parent_pipe=parent_pipe,
 
2718
                                  proc=proc,
 
2719
                                  client_object=client))
2301
2720
            parent_pipe.send(True)
2302
2721
            # remove the old hook in favor of the new above hook on
2303
2722
            # same fileno
2306
2725
            funcname = request[1]
2307
2726
            args = request[2]
2308
2727
            kwargs = request[3]
2309
 
            
 
2728
 
2310
2729
            parent_pipe.send(('data', getattr(client_object,
2311
2730
                                              funcname)(*args,
2312
2731
                                                        **kwargs)))
2313
 
        
 
2732
 
2314
2733
        if command == 'getattr':
2315
2734
            attrname = request[1]
2316
2735
            if isinstance(client_object.__getattribute__(attrname),
2319
2738
            else:
2320
2739
                parent_pipe.send((
2321
2740
                    'data', client_object.__getattribute__(attrname)))
2322
 
        
 
2741
 
2323
2742
        if command == 'setattr':
2324
2743
            attrname = request[1]
2325
2744
            value = request[2]
2326
2745
            setattr(client_object, attrname, value)
2327
 
        
 
2746
 
2328
2747
        return True
2329
2748
 
2330
2749
 
2331
2750
def rfc3339_duration_to_delta(duration):
2332
2751
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2333
 
    
 
2752
 
2334
2753
    >>> rfc3339_duration_to_delta("P7D")
2335
2754
    datetime.timedelta(7)
2336
2755
    >>> rfc3339_duration_to_delta("PT60S")
2346
2765
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2347
2766
    datetime.timedelta(1, 200)
2348
2767
    """
2349
 
    
 
2768
 
2350
2769
    # Parsing an RFC 3339 duration with regular expressions is not
2351
2770
    # possible - there would have to be multiple places for the same
2352
2771
    # values, like seconds.  The current code, while more esoteric, is
2353
2772
    # cleaner without depending on a parsing library.  If Python had a
2354
2773
    # built-in library for parsing we would use it, but we'd like to
2355
2774
    # avoid excessive use of external libraries.
2356
 
    
 
2775
 
2357
2776
    # New type for defining tokens, syntax, and semantics all-in-one
2358
2777
    Token = collections.namedtuple("Token", (
2359
2778
        "regexp",  # To match token; if "value" is not None, must have
2392
2811
                           frozenset((token_year, token_month,
2393
2812
                                      token_day, token_time,
2394
2813
                                      token_week)))
2395
 
    # Define starting values
2396
 
    value = datetime.timedelta() # Value so far
 
2814
    # Define starting values:
 
2815
    # Value so far
 
2816
    value = datetime.timedelta()
2397
2817
    found_token = None
2398
 
    followers = frozenset((token_duration, )) # Following valid tokens
2399
 
    s = duration                # String left to parse
 
2818
    # Following valid tokens
 
2819
    followers = frozenset((token_duration, ))
 
2820
    # String left to parse
 
2821
    s = duration
2400
2822
    # Loop until end token is found
2401
2823
    while found_token is not token_end:
2402
2824
        # Search for any currently valid tokens
2426
2848
 
2427
2849
def string_to_delta(interval):
2428
2850
    """Parse a string and return a datetime.timedelta
2429
 
    
 
2851
 
2430
2852
    >>> string_to_delta('7d')
2431
2853
    datetime.timedelta(7)
2432
2854
    >>> string_to_delta('60s')
2440
2862
    >>> string_to_delta('5m 30s')
2441
2863
    datetime.timedelta(0, 330)
2442
2864
    """
2443
 
    
 
2865
 
2444
2866
    try:
2445
2867
        return rfc3339_duration_to_delta(interval)
2446
2868
    except ValueError:
2447
2869
        pass
2448
 
    
 
2870
 
2449
2871
    timevalue = datetime.timedelta(0)
2450
2872
    for s in interval.split():
2451
2873
        try:
2469
2891
    return timevalue
2470
2892
 
2471
2893
 
2472
 
def daemon(nochdir = False, noclose = False):
 
2894
def daemon(nochdir=False, noclose=False):
2473
2895
    """See daemon(3).  Standard BSD Unix function.
2474
 
    
 
2896
 
2475
2897
    This should really exist as os.daemon, but it doesn't (yet)."""
2476
2898
    if os.fork():
2477
2899
        sys.exit()
2495
2917
 
2496
2918
 
2497
2919
def main():
2498
 
    
 
2920
 
2499
2921
    ##################################################################
2500
2922
    # Parsing of options, both command line and config file
2501
 
    
 
2923
 
2502
2924
    parser = argparse.ArgumentParser()
2503
2925
    parser.add_argument("-v", "--version", action="version",
2504
 
                        version = "%(prog)s {}".format(version),
 
2926
                        version="%(prog)s {}".format(version),
2505
2927
                        help="show version number and exit")
2506
2928
    parser.add_argument("-i", "--interface", metavar="IF",
2507
2929
                        help="Bind to interface IF")
2543
2965
    parser.add_argument("--no-zeroconf", action="store_false",
2544
2966
                        dest="zeroconf", help="Do not use Zeroconf",
2545
2967
                        default=None)
2546
 
    
 
2968
 
2547
2969
    options = parser.parse_args()
2548
 
    
 
2970
 
2549
2971
    if options.check:
2550
2972
        import doctest
2551
2973
        fail_count, test_count = doctest.testmod()
2552
2974
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2553
 
    
 
2975
 
2554
2976
    # Default values for config file for server-global settings
2555
 
    server_defaults = { "interface": "",
2556
 
                        "address": "",
2557
 
                        "port": "",
2558
 
                        "debug": "False",
2559
 
                        "priority":
2560
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2561
 
                        ":+SIGN-DSA-SHA256",
2562
 
                        "servicename": "Mandos",
2563
 
                        "use_dbus": "True",
2564
 
                        "use_ipv6": "True",
2565
 
                        "debuglevel": "",
2566
 
                        "restore": "True",
2567
 
                        "socket": "",
2568
 
                        "statedir": "/var/lib/mandos",
2569
 
                        "foreground": "False",
2570
 
                        "zeroconf": "True",
2571
 
                    }
2572
 
    
 
2977
    if gnutls.has_rawpk:
 
2978
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
 
2979
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
 
2980
    else:
 
2981
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2982
                    ":+SIGN-DSA-SHA256")
 
2983
    server_defaults = {"interface": "",
 
2984
                       "address": "",
 
2985
                       "port": "",
 
2986
                       "debug": "False",
 
2987
                       "priority": priority,
 
2988
                       "servicename": "Mandos",
 
2989
                       "use_dbus": "True",
 
2990
                       "use_ipv6": "True",
 
2991
                       "debuglevel": "",
 
2992
                       "restore": "True",
 
2993
                       "socket": "",
 
2994
                       "statedir": "/var/lib/mandos",
 
2995
                       "foreground": "False",
 
2996
                       "zeroconf": "True",
 
2997
                       }
 
2998
    del priority
 
2999
 
2573
3000
    # Parse config file for server-global settings
2574
3001
    server_config = configparser.SafeConfigParser(server_defaults)
2575
3002
    del server_defaults
2577
3004
    # Convert the SafeConfigParser object to a dict
2578
3005
    server_settings = server_config.defaults()
2579
3006
    # Use the appropriate methods on the non-string config options
2580
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
3007
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3008
                   "foreground", "zeroconf"):
2581
3009
        server_settings[option] = server_config.getboolean("DEFAULT",
2582
3010
                                                           option)
2583
3011
    if server_settings["port"]:
2593
3021
            server_settings["socket"] = os.dup(server_settings
2594
3022
                                               ["socket"])
2595
3023
    del server_config
2596
 
    
 
3024
 
2597
3025
    # Override the settings from the config file with command line
2598
3026
    # options, if set.
2599
3027
    for option in ("interface", "address", "port", "debug",
2617
3045
    if server_settings["debug"]:
2618
3046
        server_settings["foreground"] = True
2619
3047
    # Now we have our good server settings in "server_settings"
2620
 
    
 
3048
 
2621
3049
    ##################################################################
2622
 
    
 
3050
 
2623
3051
    if (not server_settings["zeroconf"]
2624
3052
        and not (server_settings["port"]
2625
3053
                 or server_settings["socket"] != "")):
2626
3054
        parser.error("Needs port or socket to work without Zeroconf")
2627
 
    
 
3055
 
2628
3056
    # For convenience
2629
3057
    debug = server_settings["debug"]
2630
3058
    debuglevel = server_settings["debuglevel"]
2634
3062
                                     stored_state_file)
2635
3063
    foreground = server_settings["foreground"]
2636
3064
    zeroconf = server_settings["zeroconf"]
2637
 
    
 
3065
 
2638
3066
    if debug:
2639
3067
        initlogger(debug, logging.DEBUG)
2640
3068
    else:
2643
3071
        else:
2644
3072
            level = getattr(logging, debuglevel.upper())
2645
3073
            initlogger(debug, level)
2646
 
    
 
3074
 
2647
3075
    if server_settings["servicename"] != "Mandos":
2648
3076
        syslogger.setFormatter(
2649
3077
            logging.Formatter('Mandos ({}) [%(process)d]:'
2650
3078
                              ' %(levelname)s: %(message)s'.format(
2651
3079
                                  server_settings["servicename"])))
2652
 
    
 
3080
 
2653
3081
    # Parse config file with clients
2654
3082
    client_config = configparser.SafeConfigParser(Client
2655
3083
                                                  .client_defaults)
2656
3084
    client_config.read(os.path.join(server_settings["configdir"],
2657
3085
                                    "clients.conf"))
2658
 
    
 
3086
 
2659
3087
    global mandos_dbus_service
2660
3088
    mandos_dbus_service = None
2661
 
    
 
3089
 
2662
3090
    socketfd = None
2663
3091
    if server_settings["socket"] != "":
2664
3092
        socketfd = server_settings["socket"]
2680
3108
        except IOError as e:
2681
3109
            logger.error("Could not open file %r", pidfilename,
2682
3110
                         exc_info=e)
2683
 
    
2684
 
    for name in ("_mandos", "mandos", "nobody"):
 
3111
 
 
3112
    for name, group in (("_mandos", "_mandos"),
 
3113
                        ("mandos", "mandos"),
 
3114
                        ("nobody", "nogroup")):
2685
3115
        try:
2686
3116
            uid = pwd.getpwnam(name).pw_uid
2687
 
            gid = pwd.getpwnam(name).pw_gid
 
3117
            gid = pwd.getpwnam(group).pw_gid
2688
3118
            break
2689
3119
        except KeyError:
2690
3120
            continue
2694
3124
    try:
2695
3125
        os.setgid(gid)
2696
3126
        os.setuid(uid)
 
3127
        if debug:
 
3128
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3129
                                                             gid))
2697
3130
    except OSError as error:
 
3131
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3132
                       .format(uid, gid, os.strerror(error.errno)))
2698
3133
        if error.errno != errno.EPERM:
2699
3134
            raise
2700
 
    
 
3135
 
2701
3136
    if debug:
2702
3137
        # Enable all possible GnuTLS debugging
2703
 
        
 
3138
 
2704
3139
        # "Use a log level over 10 to enable all debugging options."
2705
3140
        # - GnuTLS manual
2706
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2707
 
        
2708
 
        @gnutls.library.types.gnutls_log_func
 
3141
        gnutls.global_set_log_level(11)
 
3142
 
 
3143
        @gnutls.log_func
2709
3144
        def debug_gnutls(level, string):
2710
3145
            logger.debug("GnuTLS: %s", string[:-1])
2711
 
        
2712
 
        gnutls.library.functions.gnutls_global_set_log_function(
2713
 
            debug_gnutls)
2714
 
        
 
3146
 
 
3147
        gnutls.global_set_log_function(debug_gnutls)
 
3148
 
2715
3149
        # Redirect stdin so all checkers get /dev/null
2716
3150
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2717
3151
        os.dup2(null, sys.stdin.fileno())
2718
3152
        if null > 2:
2719
3153
            os.close(null)
2720
 
    
 
3154
 
2721
3155
    # Need to fork before connecting to D-Bus
2722
3156
    if not foreground:
2723
3157
        # Close all input and output, do double fork, etc.
2724
3158
        daemon()
2725
 
    
2726
 
    # multiprocessing will use threads, so before we use gobject we
2727
 
    # need to inform gobject that threads will be used.
2728
 
    gobject.threads_init()
2729
 
    
 
3159
 
 
3160
    # multiprocessing will use threads, so before we use GLib we need
 
3161
    # to inform GLib that threads will be used.
 
3162
    GLib.threads_init()
 
3163
 
2730
3164
    global main_loop
2731
3165
    # From the Avahi example code
2732
3166
    DBusGMainLoop(set_as_default=True)
2733
 
    main_loop = gobject.MainLoop()
 
3167
    main_loop = GLib.MainLoop()
2734
3168
    bus = dbus.SystemBus()
2735
3169
    # End of Avahi example code
2736
3170
    if use_dbus:
2749
3183
    if zeroconf:
2750
3184
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2751
3185
        service = AvahiServiceToSyslog(
2752
 
            name = server_settings["servicename"],
2753
 
            servicetype = "_mandos._tcp",
2754
 
            protocol = protocol,
2755
 
            bus = bus)
 
3186
            name=server_settings["servicename"],
 
3187
            servicetype="_mandos._tcp",
 
3188
            protocol=protocol,
 
3189
            bus=bus)
2756
3190
        if server_settings["interface"]:
2757
3191
            service.interface = if_nametoindex(
2758
3192
                server_settings["interface"].encode("utf-8"))
2759
 
    
 
3193
 
2760
3194
    global multiprocessing_manager
2761
3195
    multiprocessing_manager = multiprocessing.Manager()
2762
 
    
 
3196
 
2763
3197
    client_class = Client
2764
3198
    if use_dbus:
2765
 
        client_class = functools.partial(ClientDBus, bus = bus)
2766
 
    
 
3199
        client_class = functools.partial(ClientDBus, bus=bus)
 
3200
 
2767
3201
    client_settings = Client.config_parser(client_config)
2768
3202
    old_client_settings = {}
2769
3203
    clients_data = {}
2770
 
    
 
3204
 
2771
3205
    # This is used to redirect stdout and stderr for checker processes
2772
3206
    global wnull
2773
 
    wnull = open(os.devnull, "w") # A writable /dev/null
 
3207
    wnull = open(os.devnull, "w")  # A writable /dev/null
2774
3208
    # Only used if server is running in foreground but not in debug
2775
3209
    # mode
2776
3210
    if debug or not foreground:
2777
3211
        wnull.close()
2778
 
    
 
3212
 
2779
3213
    # Get client data and settings from last running state.
2780
3214
    if server_settings["restore"]:
2781
3215
        try:
2782
3216
            with open(stored_state_path, "rb") as stored_state:
2783
 
                clients_data, old_client_settings = pickle.load(
2784
 
                    stored_state)
 
3217
                if sys.version_info.major == 2:
 
3218
                    clients_data, old_client_settings = pickle.load(
 
3219
                        stored_state)
 
3220
                else:
 
3221
                    bytes_clients_data, bytes_old_client_settings = (
 
3222
                        pickle.load(stored_state, encoding="bytes"))
 
3223
                    #   Fix bytes to strings
 
3224
                    #  clients_data
 
3225
                    # .keys()
 
3226
                    clients_data = {(key.decode("utf-8")
 
3227
                                     if isinstance(key, bytes)
 
3228
                                     else key): value
 
3229
                                    for key, value in
 
3230
                                    bytes_clients_data.items()}
 
3231
                    del bytes_clients_data
 
3232
                    for key in clients_data:
 
3233
                        value = {(k.decode("utf-8")
 
3234
                                  if isinstance(k, bytes) else k): v
 
3235
                                 for k, v in
 
3236
                                 clients_data[key].items()}
 
3237
                        clients_data[key] = value
 
3238
                        # .client_structure
 
3239
                        value["client_structure"] = [
 
3240
                            (s.decode("utf-8")
 
3241
                             if isinstance(s, bytes)
 
3242
                             else s) for s in
 
3243
                            value["client_structure"]]
 
3244
                        # .name & .host
 
3245
                        for k in ("name", "host"):
 
3246
                            if isinstance(value[k], bytes):
 
3247
                                value[k] = value[k].decode("utf-8")
 
3248
                        if "key_id" not in value:
 
3249
                            value["key_id"] = ""
 
3250
                        elif "fingerprint" not in value:
 
3251
                            value["fingerprint"] = ""
 
3252
                    #  old_client_settings
 
3253
                    # .keys()
 
3254
                    old_client_settings = {
 
3255
                        (key.decode("utf-8")
 
3256
                         if isinstance(key, bytes)
 
3257
                         else key): value
 
3258
                        for key, value in
 
3259
                        bytes_old_client_settings.items()}
 
3260
                    del bytes_old_client_settings
 
3261
                    # .host
 
3262
                    for value in old_client_settings.values():
 
3263
                        if isinstance(value["host"], bytes):
 
3264
                            value["host"] = (value["host"]
 
3265
                                             .decode("utf-8"))
2785
3266
            os.remove(stored_state_path)
2786
3267
        except IOError as e:
2787
3268
            if e.errno == errno.ENOENT:
2795
3276
            logger.warning("Could not load persistent state: "
2796
3277
                           "EOFError:",
2797
3278
                           exc_info=e)
2798
 
    
 
3279
 
2799
3280
    with PGPEngine() as pgp:
2800
3281
        for client_name, client in clients_data.items():
2801
3282
            # Skip removed clients
2802
3283
            if client_name not in client_settings:
2803
3284
                continue
2804
 
            
 
3285
 
2805
3286
            # Decide which value to use after restoring saved state.
2806
3287
            # We have three different values: Old config file,
2807
3288
            # new config file, and saved state.
2818
3299
                        client[name] = value
2819
3300
                except KeyError:
2820
3301
                    pass
2821
 
            
 
3302
 
2822
3303
            # Clients who has passed its expire date can still be
2823
3304
            # enabled if its last checker was successful.  A Client
2824
3305
            # whose checker succeeded before we stored its state is
2857
3338
                    client_name))
2858
3339
                client["secret"] = (client_settings[client_name]
2859
3340
                                    ["secret"])
2860
 
    
 
3341
 
2861
3342
    # Add/remove clients based on new changes made to config
2862
3343
    for client_name in (set(old_client_settings)
2863
3344
                        - set(client_settings)):
2865
3346
    for client_name in (set(client_settings)
2866
3347
                        - set(old_client_settings)):
2867
3348
        clients_data[client_name] = client_settings[client_name]
2868
 
    
 
3349
 
2869
3350
    # Create all client objects
2870
3351
    for client_name, client in clients_data.items():
2871
3352
        tcp_server.clients[client_name] = client_class(
2872
 
            name = client_name,
2873
 
            settings = client,
2874
 
            server_settings = server_settings)
2875
 
    
 
3353
            name=client_name,
 
3354
            settings=client,
 
3355
            server_settings=server_settings)
 
3356
 
2876
3357
    if not tcp_server.clients:
2877
3358
        logger.warning("No clients defined")
2878
 
    
 
3359
 
2879
3360
    if not foreground:
2880
3361
        if pidfile is not None:
2881
3362
            pid = os.getpid()
2887
3368
                             pidfilename, pid)
2888
3369
        del pidfile
2889
3370
        del pidfilename
2890
 
    
2891
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2892
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2893
 
    
 
3371
 
 
3372
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3373
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3374
                             lambda: main_loop.quit() and False)
 
3375
 
2894
3376
    if use_dbus:
2895
 
        
 
3377
 
2896
3378
        @alternate_dbus_interfaces(
2897
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
3379
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
2898
3380
        class MandosDBusService(DBusObjectWithObjectManager):
2899
3381
            """A D-Bus proxy object"""
2900
 
            
 
3382
 
2901
3383
            def __init__(self):
2902
3384
                dbus.service.Object.__init__(self, bus, "/")
2903
 
            
 
3385
 
2904
3386
            _interface = "se.recompile.Mandos"
2905
 
            
 
3387
 
2906
3388
            @dbus.service.signal(_interface, signature="o")
2907
3389
            def ClientAdded(self, objpath):
2908
3390
                "D-Bus signal"
2909
3391
                pass
2910
 
            
 
3392
 
2911
3393
            @dbus.service.signal(_interface, signature="ss")
2912
 
            def ClientNotFound(self, fingerprint, address):
 
3394
            def ClientNotFound(self, key_id, address):
2913
3395
                "D-Bus signal"
2914
3396
                pass
2915
 
            
 
3397
 
2916
3398
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2917
3399
                               "true"})
2918
3400
            @dbus.service.signal(_interface, signature="os")
2919
3401
            def ClientRemoved(self, objpath, name):
2920
3402
                "D-Bus signal"
2921
3403
                pass
2922
 
            
 
3404
 
2923
3405
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2924
3406
                               "true"})
2925
3407
            @dbus.service.method(_interface, out_signature="ao")
2926
3408
            def GetAllClients(self):
2927
3409
                "D-Bus method"
2928
3410
                return dbus.Array(c.dbus_object_path for c in
2929
 
                                  tcp_server.clients.itervalues())
2930
 
            
 
3411
                                  tcp_server.clients.values())
 
3412
 
2931
3413
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2932
3414
                               "true"})
2933
3415
            @dbus.service.method(_interface,
2935
3417
            def GetAllClientsWithProperties(self):
2936
3418
                "D-Bus method"
2937
3419
                return dbus.Dictionary(
2938
 
                    { c.dbus_object_path: c.GetAll(
 
3420
                    {c.dbus_object_path: c.GetAll(
2939
3421
                        "se.recompile.Mandos.Client")
2940
 
                      for c in tcp_server.clients.itervalues() },
 
3422
                     for c in tcp_server.clients.values()},
2941
3423
                    signature="oa{sv}")
2942
 
            
 
3424
 
2943
3425
            @dbus.service.method(_interface, in_signature="o")
2944
3426
            def RemoveClient(self, object_path):
2945
3427
                "D-Bus method"
2946
 
                for c in tcp_server.clients.itervalues():
 
3428
                for c in tcp_server.clients.values():
2947
3429
                    if c.dbus_object_path == object_path:
2948
3430
                        del tcp_server.clients[c.name]
2949
3431
                        c.remove_from_connection()
2953
3435
                        self.client_removed_signal(c)
2954
3436
                        return
2955
3437
                raise KeyError(object_path)
2956
 
            
 
3438
 
2957
3439
            del _interface
2958
 
            
 
3440
 
2959
3441
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
2960
 
                                 out_signature = "a{oa{sa{sv}}}")
 
3442
                                 out_signature="a{oa{sa{sv}}}")
2961
3443
            def GetManagedObjects(self):
2962
3444
                """D-Bus method"""
2963
3445
                return dbus.Dictionary(
2964
 
                    { client.dbus_object_path:
2965
 
                      dbus.Dictionary(
2966
 
                          { interface: client.GetAll(interface)
2967
 
                            for interface in
2968
 
                                 client._get_all_interface_names()})
2969
 
                      for client in tcp_server.clients.values()})
2970
 
            
 
3446
                    {client.dbus_object_path:
 
3447
                     dbus.Dictionary(
 
3448
                         {interface: client.GetAll(interface)
 
3449
                          for interface in
 
3450
                          client._get_all_interface_names()})
 
3451
                     for client in tcp_server.clients.values()})
 
3452
 
2971
3453
            def client_added_signal(self, client):
2972
3454
                """Send the new standard signal and the old signal"""
2973
3455
                if use_dbus:
2975
3457
                    self.InterfacesAdded(
2976
3458
                        client.dbus_object_path,
2977
3459
                        dbus.Dictionary(
2978
 
                            { interface: client.GetAll(interface)
2979
 
                              for interface in
2980
 
                              client._get_all_interface_names()}))
 
3460
                            {interface: client.GetAll(interface)
 
3461
                             for interface in
 
3462
                             client._get_all_interface_names()}))
2981
3463
                    # Old signal
2982
3464
                    self.ClientAdded(client.dbus_object_path)
2983
 
            
 
3465
 
2984
3466
            def client_removed_signal(self, client):
2985
3467
                """Send the new standard signal and the old signal"""
2986
3468
                if use_dbus:
2991
3473
                    # Old signal
2992
3474
                    self.ClientRemoved(client.dbus_object_path,
2993
3475
                                       client.name)
2994
 
        
 
3476
 
2995
3477
        mandos_dbus_service = MandosDBusService()
2996
 
    
 
3478
 
 
3479
    # Save modules to variables to exempt the modules from being
 
3480
    # unloaded before the function registered with atexit() is run.
 
3481
    mp = multiprocessing
 
3482
    wn = wnull
 
3483
 
2997
3484
    def cleanup():
2998
3485
        "Cleanup function; run on exit"
2999
3486
        if zeroconf:
3000
3487
            service.cleanup()
3001
 
        
3002
 
        multiprocessing.active_children()
3003
 
        wnull.close()
 
3488
 
 
3489
        mp.active_children()
 
3490
        wn.close()
3004
3491
        if not (tcp_server.clients or client_settings):
3005
3492
            return
3006
 
        
 
3493
 
3007
3494
        # Store client before exiting. Secrets are encrypted with key
3008
3495
        # based on what config file has. If config file is
3009
3496
        # removed/edited, old secret will thus be unrecovable.
3010
3497
        clients = {}
3011
3498
        with PGPEngine() as pgp:
3012
 
            for client in tcp_server.clients.itervalues():
 
3499
            for client in tcp_server.clients.values():
3013
3500
                key = client_settings[client.name]["secret"]
3014
3501
                client.encrypted_secret = pgp.encrypt(client.secret,
3015
3502
                                                      key)
3016
3503
                client_dict = {}
3017
 
                
 
3504
 
3018
3505
                # A list of attributes that can not be pickled
3019
3506
                # + secret.
3020
 
                exclude = { "bus", "changedstate", "secret",
3021
 
                            "checker", "server_settings" }
 
3507
                exclude = {"bus", "changedstate", "secret",
 
3508
                           "checker", "server_settings"}
3022
3509
                for name, typ in inspect.getmembers(dbus.service
3023
3510
                                                    .Object):
3024
3511
                    exclude.add(name)
3025
 
                
 
3512
 
3026
3513
                client_dict["encrypted_secret"] = (client
3027
3514
                                                   .encrypted_secret)
3028
3515
                for attr in client.client_structure:
3029
3516
                    if attr not in exclude:
3030
3517
                        client_dict[attr] = getattr(client, attr)
3031
 
                
 
3518
 
3032
3519
                clients[client.name] = client_dict
3033
3520
                del client_settings[client.name]["secret"]
3034
 
        
 
3521
 
3035
3522
        try:
3036
3523
            with tempfile.NamedTemporaryFile(
3037
3524
                    mode='wb',
3039
3526
                    prefix='clients-',
3040
3527
                    dir=os.path.dirname(stored_state_path),
3041
3528
                    delete=False) as stored_state:
3042
 
                pickle.dump((clients, client_settings), stored_state)
 
3529
                pickle.dump((clients, client_settings), stored_state,
 
3530
                            protocol=2)
3043
3531
                tempname = stored_state.name
3044
3532
            os.rename(tempname, stored_state_path)
3045
3533
        except (IOError, OSError) as e:
3055
3543
                logger.warning("Could not save persistent state:",
3056
3544
                               exc_info=e)
3057
3545
                raise
3058
 
        
 
3546
 
3059
3547
        # Delete all clients, and settings from config
3060
3548
        while tcp_server.clients:
3061
3549
            name, client = tcp_server.clients.popitem()
3064
3552
            # Don't signal the disabling
3065
3553
            client.disable(quiet=True)
3066
3554
            # Emit D-Bus signal for removal
3067
 
            mandos_dbus_service.client_removed_signal(client)
 
3555
            if use_dbus:
 
3556
                mandos_dbus_service.client_removed_signal(client)
3068
3557
        client_settings.clear()
3069
 
    
 
3558
 
3070
3559
    atexit.register(cleanup)
3071
 
    
3072
 
    for client in tcp_server.clients.itervalues():
 
3560
 
 
3561
    for client in tcp_server.clients.values():
3073
3562
        if use_dbus:
3074
3563
            # Emit D-Bus signal for adding
3075
3564
            mandos_dbus_service.client_added_signal(client)
3076
3565
        # Need to initiate checking of clients
3077
3566
        if client.enabled:
3078
3567
            client.init_checker()
3079
 
    
 
3568
 
3080
3569
    tcp_server.enable()
3081
3570
    tcp_server.server_activate()
3082
 
    
 
3571
 
3083
3572
    # Find out what port we got
3084
3573
    if zeroconf:
3085
3574
        service.port = tcp_server.socket.getsockname()[1]
3090
3579
    else:                       # IPv4
3091
3580
        logger.info("Now listening on address %r, port %d",
3092
3581
                    *tcp_server.socket.getsockname())
3093
 
    
3094
 
    #service.interface = tcp_server.socket.getsockname()[3]
3095
 
    
 
3582
 
 
3583
    # service.interface = tcp_server.socket.getsockname()[3]
 
3584
 
3096
3585
    try:
3097
3586
        if zeroconf:
3098
3587
            # From the Avahi example code
3103
3592
                cleanup()
3104
3593
                sys.exit(1)
3105
3594
            # End of Avahi example code
3106
 
        
3107
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3108
 
                             lambda *args, **kwargs:
3109
 
                             (tcp_server.handle_request
3110
 
                              (*args[2:], **kwargs) or True))
3111
 
        
 
3595
 
 
3596
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3597
                          lambda *args, **kwargs:
 
3598
                          (tcp_server.handle_request
 
3599
                           (*args[2:], **kwargs) or True))
 
3600
 
3112
3601
        logger.debug("Starting main loop")
3113
3602
        main_loop.run()
3114
3603
    except AvahiError as error: