/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-07-06 21:02:27 UTC
  • Revision ID: teddy@recompile.se-20150706210227-4wz9tazr6bte3js1
debian/control (Build-Depends): Bug fix: Added "libnl-route-3-dev".

Show diffs side-by-side

added added

removed removed

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