/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-08-24 14:52:59 UTC
  • Revision ID: teddy@recompile.se-20190824145259-ifatm1r12kyp4z25
Server: Use new GLib.io_add_watch() call signature

* INSTALL: Increase version requirement of PyGObject to 3.8.
* mandos: When calling GLib.io_add_watch(), always pass priority as
          the second argument, which is supported by PyGObject 3.8 or
          later.

Show diffs side-by-side

added added

removed removed

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