/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-07-12 01:41:14 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150712014114-qbala4mutkixxct3
Handle local Zeroconf service name collisions on startup, too.

* mandos (AvahiService.server_state_changed): Catch name collision
                                              error when adding
                                              server.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -b
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)
492
412
                logger.debug("Unknown state: %r", state)
493
413
            else:
494
414
                logger.debug("Unknown state: %r: %r", state, error)
495
 
 
 
415
    
496
416
    def activate(self):
497
417
        """Derived from the Avahi example code"""
498
418
        if self.server is None:
509
429
class AvahiServiceToSyslog(AvahiService):
510
430
    def rename(self, *args, **kwargs):
511
431
        """Add the new name to the syslog messages"""
512
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
432
        ret = AvahiService.rename(self, *args, **kwargs)
513
433
        syslogger.setFormatter(logging.Formatter(
514
434
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
515
435
            .format(self.name)))
516
436
        return ret
517
437
 
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
438
def call_pipe(connection,       # : multiprocessing.Connection
821
439
              func, *args, **kwargs):
822
440
    """This function is meant to be called by multiprocessing.Process
823
 
 
 
441
    
824
442
    This function runs func(*args, **kwargs), and writes the resulting
825
443
    return value on the provided multiprocessing.Connection.
826
444
    """
827
445
    connection.send(func(*args, **kwargs))
828
446
    connection.close()
829
447
 
830
 
 
831
 
class Client:
 
448
class Client(object):
832
449
    """A representation of a client host served by this server.
833
 
 
 
450
    
834
451
    Attributes:
835
452
    approved:   bool(); 'None' if not yet approved/disapproved
836
453
    approval_delay: datetime.timedelta(); Time to wait for approval
837
454
    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
 
455
    checker:    subprocess.Popen(); a running checker process used
 
456
                                    to see if the client lives.
 
457
                                    'None' if no process is running.
 
458
    checker_callback_tag: a gobject event source tag, or None
842
459
    checker_command: string; External command which is run to check
843
460
                     if client lives.  %() expansions are done at
844
461
                     runtime with vars(self) as dict, so that for
845
462
                     instance %(name)s can be used in the command.
846
 
    checker_initiator_tag: a GLib event source tag, or None
 
463
    checker_initiator_tag: a gobject event source tag, or None
847
464
    created:    datetime.datetime(); (UTC) object creation
848
465
    client_structure: Object describing what attributes a client has
849
466
                      and is used for storing the client at exit
850
467
    current_checker_command: string; current running checker_command
851
 
    disable_initiator_tag: a GLib event source tag, or None
 
468
    disable_initiator_tag: a gobject event source tag, or None
852
469
    enabled:    bool()
853
470
    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
 
471
                 uniquely identify the client
857
472
    host:       string; available for use by the checker command
858
473
    interval:   datetime.timedelta(); How often to start a new checker
859
474
    last_approval_request: datetime.datetime(); (UTC) or None
875
490
                disabled, or None
876
491
    server_settings: The server_settings dict from main()
877
492
    """
878
 
 
 
493
    
879
494
    runtime_expansions = ("approval_delay", "approval_duration",
880
 
                          "created", "enabled", "expires", "key_id",
 
495
                          "created", "enabled", "expires",
881
496
                          "fingerprint", "host", "interval",
882
497
                          "last_approval_request", "last_checked_ok",
883
498
                          "last_enabled", "name", "timeout")
892
507
        "approved_by_default": "True",
893
508
        "enabled": "True",
894
509
    }
895
 
 
 
510
    
896
511
    @staticmethod
897
512
    def config_parser(config):
898
513
        """Construct a new dict of client settings of this form:
905
520
        for client_name in config.sections():
906
521
            section = dict(config.items(client_name))
907
522
            client = settings[client_name] = {}
908
 
 
 
523
            
909
524
            client["host"] = section["host"]
910
525
            # Reformat values from string types to Python types
911
526
            client["approved_by_default"] = config.getboolean(
912
527
                client_name, "approved_by_default")
913
528
            client["enabled"] = config.getboolean(client_name,
914
529
                                                  "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(" ", ""))
 
530
            
 
531
            # Uppercase and remove spaces from fingerprint for later
 
532
            # comparison purposes with return value from the
 
533
            # fingerprint() function
921
534
            client["fingerprint"] = (section["fingerprint"].upper()
922
535
                                     .replace(" ", ""))
923
536
            if "secret" in section:
924
 
                client["secret"] = codecs.decode(section["secret"]
925
 
                                                 .encode("utf-8"),
926
 
                                                 "base64")
 
537
                client["secret"] = section["secret"].decode("base64")
927
538
            elif "secfile" in section:
928
539
                with open(os.path.expanduser(os.path.expandvars
929
540
                                             (section["secfile"])),
944
555
            client["last_approval_request"] = None
945
556
            client["last_checked_ok"] = None
946
557
            client["last_checker_status"] = -2
947
 
 
 
558
        
948
559
        return settings
949
 
 
950
 
    def __init__(self, settings, name=None, server_settings=None):
 
560
    
 
561
    def __init__(self, settings, name = None, server_settings=None):
951
562
        self.name = name
952
563
        if server_settings is None:
953
564
            server_settings = {}
955
566
        # adding all client settings
956
567
        for setting, value in settings.items():
957
568
            setattr(self, setting, value)
958
 
 
 
569
        
959
570
        if self.enabled:
960
571
            if not hasattr(self, "last_enabled"):
961
572
                self.last_enabled = datetime.datetime.utcnow()
965
576
        else:
966
577
            self.last_enabled = None
967
578
            self.expires = None
968
 
 
 
579
        
969
580
        logger.debug("Creating client %r", self.name)
970
 
        logger.debug("  Key ID: %s", self.key_id)
971
581
        logger.debug("  Fingerprint: %s", self.fingerprint)
972
582
        self.created = settings.get("created",
973
583
                                    datetime.datetime.utcnow())
974
 
 
 
584
        
975
585
        # attributes specific for this server instance
976
586
        self.checker = None
977
587
        self.checker_initiator_tag = None
983
593
        self.changedstate = multiprocessing_manager.Condition(
984
594
            multiprocessing_manager.Lock())
985
595
        self.client_structure = [attr
986
 
                                 for attr in self.__dict__.keys()
 
596
                                 for attr in self.__dict__.iterkeys()
987
597
                                 if not attr.startswith("_")]
988
598
        self.client_structure.append("client_structure")
989
 
 
 
599
        
990
600
        for name, t in inspect.getmembers(
991
601
                type(self), lambda obj: isinstance(obj, property)):
992
602
            if not name.startswith("_"):
993
603
                self.client_structure.append(name)
994
 
 
 
604
    
995
605
    # Send notice to process children that client state has changed
996
606
    def send_changedstate(self):
997
607
        with self.changedstate:
998
608
            self.changedstate.notify_all()
999
 
 
 
609
    
1000
610
    def enable(self):
1001
611
        """Start this client's checker and timeout hooks"""
1002
612
        if getattr(self, "enabled", False):
1007
617
        self.last_enabled = datetime.datetime.utcnow()
1008
618
        self.init_checker()
1009
619
        self.send_changedstate()
1010
 
 
 
620
    
1011
621
    def disable(self, quiet=True):
1012
622
        """Disable this client."""
1013
623
        if not getattr(self, "enabled", False):
1015
625
        if not quiet:
1016
626
            logger.info("Disabling client %s", self.name)
1017
627
        if getattr(self, "disable_initiator_tag", None) is not None:
1018
 
            GLib.source_remove(self.disable_initiator_tag)
 
628
            gobject.source_remove(self.disable_initiator_tag)
1019
629
            self.disable_initiator_tag = None
1020
630
        self.expires = None
1021
631
        if getattr(self, "checker_initiator_tag", None) is not None:
1022
 
            GLib.source_remove(self.checker_initiator_tag)
 
632
            gobject.source_remove(self.checker_initiator_tag)
1023
633
            self.checker_initiator_tag = None
1024
634
        self.stop_checker()
1025
635
        self.enabled = False
1026
636
        if not quiet:
1027
637
            self.send_changedstate()
1028
 
        # Do not run this again if called by a GLib.timeout_add
 
638
        # Do not run this again if called by a gobject.timeout_add
1029
639
        return False
1030
 
 
 
640
    
1031
641
    def __del__(self):
1032
642
        self.disable()
1033
 
 
 
643
    
1034
644
    def init_checker(self):
1035
645
        # Schedule a new checker to be started an 'interval' from now,
1036
646
        # and every interval from then on.
1037
647
        if self.checker_initiator_tag is not None:
1038
 
            GLib.source_remove(self.checker_initiator_tag)
1039
 
        self.checker_initiator_tag = GLib.timeout_add(
 
648
            gobject.source_remove(self.checker_initiator_tag)
 
649
        self.checker_initiator_tag = gobject.timeout_add(
1040
650
            int(self.interval.total_seconds() * 1000),
1041
651
            self.start_checker)
1042
652
        # Schedule a disable() when 'timeout' has passed
1043
653
        if self.disable_initiator_tag is not None:
1044
 
            GLib.source_remove(self.disable_initiator_tag)
1045
 
        self.disable_initiator_tag = GLib.timeout_add(
 
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
        self.disable_initiator_tag = gobject.timeout_add(
1046
656
            int(self.timeout.total_seconds() * 1000), self.disable)
1047
657
        # Also start a new checker *right now*.
1048
658
        self.start_checker()
1049
 
 
 
659
    
1050
660
    def checker_callback(self, source, condition, connection,
1051
661
                         command):
1052
662
        """The checker has completed, so take appropriate actions."""
 
663
        self.checker_callback_tag = None
 
664
        self.checker = None
1053
665
        # Read return code from connection (see call_pipe)
1054
666
        returncode = connection.recv()
1055
667
        connection.close()
1056
 
        self.checker.join()
1057
 
        self.checker_callback_tag = None
1058
 
        self.checker = None
1059
 
 
 
668
        
1060
669
        if returncode >= 0:
1061
670
            self.last_checker_status = returncode
1062
671
            self.last_checker_signal = None
1072
681
            logger.warning("Checker for %(name)s crashed?",
1073
682
                           vars(self))
1074
683
        return False
1075
 
 
 
684
    
1076
685
    def checked_ok(self):
1077
686
        """Assert that the client has been seen, alive and well."""
1078
687
        self.last_checked_ok = datetime.datetime.utcnow()
1079
688
        self.last_checker_status = 0
1080
689
        self.last_checker_signal = None
1081
690
        self.bump_timeout()
1082
 
 
 
691
    
1083
692
    def bump_timeout(self, timeout=None):
1084
693
        """Bump up the timeout for this client."""
1085
694
        if timeout is None:
1086
695
            timeout = self.timeout
1087
696
        if self.disable_initiator_tag is not None:
1088
 
            GLib.source_remove(self.disable_initiator_tag)
 
697
            gobject.source_remove(self.disable_initiator_tag)
1089
698
            self.disable_initiator_tag = None
1090
699
        if getattr(self, "enabled", False):
1091
 
            self.disable_initiator_tag = GLib.timeout_add(
 
700
            self.disable_initiator_tag = gobject.timeout_add(
1092
701
                int(timeout.total_seconds() * 1000), self.disable)
1093
702
            self.expires = datetime.datetime.utcnow() + timeout
1094
 
 
 
703
    
1095
704
    def need_approval(self):
1096
705
        self.last_approval_request = datetime.datetime.utcnow()
1097
 
 
 
706
    
1098
707
    def start_checker(self):
1099
708
        """Start a new checker subprocess if one is not running.
1100
 
 
 
709
        
1101
710
        If a checker already exists, leave it running and do
1102
711
        nothing."""
1103
712
        # The reason for not killing a running checker is that if we
1108
717
        # checkers alone, the checker would have to take more time
1109
718
        # than 'timeout' for the client to be disabled, which is as it
1110
719
        # should be.
1111
 
 
 
720
        
1112
721
        if self.checker is not None and not self.checker.is_alive():
1113
722
            logger.warning("Checker was not alive; joining")
1114
723
            self.checker.join()
1118
727
            # Escape attributes for the shell
1119
728
            escaped_attrs = {
1120
729
                attr: re.escape(str(getattr(self, attr)))
1121
 
                for attr in self.runtime_expansions}
 
730
                for attr in self.runtime_expansions }
1122
731
            try:
1123
732
                command = self.checker_command % escaped_attrs
1124
733
            except TypeError as error:
1136
745
            # The exception is when not debugging but nevertheless
1137
746
            # running in the foreground; use the previously
1138
747
            # created wnull.
1139
 
            popen_args = {"close_fds": True,
1140
 
                          "shell": True,
1141
 
                          "cwd": "/"}
 
748
            popen_args = { "close_fds": True,
 
749
                           "shell": True,
 
750
                           "cwd": "/" }
1142
751
            if (not self.server_settings["debug"]
1143
752
                and self.server_settings["foreground"]):
1144
753
                popen_args.update({"stdout": wnull,
1145
 
                                   "stderr": wnull})
1146
 
            pipe = multiprocessing.Pipe(duplex=False)
 
754
                                   "stderr": wnull })
 
755
            pipe = multiprocessing.Pipe(duplex = False)
1147
756
            self.checker = multiprocessing.Process(
1148
 
                target=call_pipe,
1149
 
                args=(pipe[1], subprocess.call, command),
1150
 
                kwargs=popen_args)
 
757
                target = call_pipe,
 
758
                args = (pipe[1], subprocess.call, command),
 
759
                kwargs = popen_args)
1151
760
            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,
 
761
            self.checker_callback_tag = gobject.io_add_watch(
 
762
                pipe[0].fileno(), gobject.IO_IN,
1155
763
                self.checker_callback, pipe[0], command)
1156
 
        # Re-run this periodically if run by GLib.timeout_add
 
764
        # Re-run this periodically if run by gobject.timeout_add
1157
765
        return True
1158
 
 
 
766
    
1159
767
    def stop_checker(self):
1160
768
        """Force the checker process, if any, to stop."""
1161
769
        if self.checker_callback_tag:
1162
 
            GLib.source_remove(self.checker_callback_tag)
 
770
            gobject.source_remove(self.checker_callback_tag)
1163
771
            self.checker_callback_tag = None
1164
772
        if getattr(self, "checker", None) is None:
1165
773
            return
1174
782
                          byte_arrays=False):
1175
783
    """Decorators for marking methods of a DBusObjectWithProperties to
1176
784
    become properties on the D-Bus.
1177
 
 
 
785
    
1178
786
    The decorated method will be called with no arguments by "Get"
1179
787
    and with one argument by "Set".
1180
 
 
 
788
    
1181
789
    The parameters, where they are supported, are the same as
1182
790
    dbus.service.method, except there is only "signature", since the
1183
791
    type from Get() and the type sent to Set() is the same.
1187
795
    if byte_arrays and signature != "ay":
1188
796
        raise ValueError("Byte arrays not supported for non-'ay'"
1189
797
                         " signature {!r}".format(signature))
1190
 
 
 
798
    
1191
799
    def decorator(func):
1192
800
        func._dbus_is_property = True
1193
801
        func._dbus_interface = dbus_interface
1196
804
        func._dbus_name = func.__name__
1197
805
        if func._dbus_name.endswith("_dbus_property"):
1198
806
            func._dbus_name = func._dbus_name[:-14]
1199
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1200
808
        return func
1201
 
 
 
809
    
1202
810
    return decorator
1203
811
 
1204
812
 
1205
813
def dbus_interface_annotations(dbus_interface):
1206
814
    """Decorator for marking functions returning interface annotations
1207
 
 
 
815
    
1208
816
    Usage:
1209
 
 
 
817
    
1210
818
    @dbus_interface_annotations("org.example.Interface")
1211
819
    def _foo(self):  # Function name does not matter
1212
820
        return {"org.freedesktop.DBus.Deprecated": "true",
1213
821
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
1214
822
                    "false"}
1215
823
    """
1216
 
 
 
824
    
1217
825
    def decorator(func):
1218
826
        func._dbus_is_interface = True
1219
827
        func._dbus_interface = dbus_interface
1220
828
        func._dbus_name = dbus_interface
1221
829
        return func
1222
 
 
 
830
    
1223
831
    return decorator
1224
832
 
1225
833
 
1226
834
def dbus_annotations(annotations):
1227
835
    """Decorator to annotate D-Bus methods, signals or properties
1228
836
    Usage:
1229
 
 
 
837
    
1230
838
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1231
839
                       "org.freedesktop.DBus.Property."
1232
840
                       "EmitsChangedSignal": "false"})
1234
842
                           access="r")
1235
843
    def Property_dbus_property(self):
1236
844
        return dbus.Boolean(False)
1237
 
 
1238
 
    See also the DBusObjectWithAnnotations class.
1239
845
    """
1240
 
 
 
846
    
1241
847
    def decorator(func):
1242
848
        func._dbus_annotations = annotations
1243
849
        return func
1244
 
 
 
850
    
1245
851
    return decorator
1246
852
 
1247
853
 
1263
869
    pass
1264
870
 
1265
871
 
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.
 
872
class DBusObjectWithProperties(dbus.service.Object):
 
873
    """A D-Bus object with properties.
 
874
    
 
875
    Classes inheriting from this can use the dbus_service_property
 
876
    decorator to expose methods as D-Bus properties.  It exposes the
 
877
    standard Get(), Set(), and GetAll() methods on the D-Bus.
1271
878
    """
1272
 
 
 
879
    
1273
880
    @staticmethod
1274
881
    def _is_dbus_thing(thing):
1275
882
        """Returns a function testing if an attribute is a D-Bus thing
1276
 
 
 
883
        
1277
884
        If called like _is_dbus_thing("method") it returns a function
1278
885
        suitable for use as predicate to inspect.getmembers().
1279
886
        """
1280
887
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1281
888
                                   False)
1282
 
 
 
889
    
1283
890
    def _get_all_dbus_things(self, thing):
1284
891
        """Returns a generator of (name, attribute) pairs
1285
892
        """
1288
895
                for cls in self.__class__.__mro__
1289
896
                for name, athing in
1290
897
                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
 
 
 
898
    
1363
899
    def _get_dbus_property(self, interface_name, property_name):
1364
900
        """Returns a bound method if one exists which is a D-Bus
1365
901
        property with the specified name and interface.
1370
906
                if (value._dbus_name == property_name
1371
907
                    and value._dbus_interface == interface_name):
1372
908
                    return value.__get__(self)
1373
 
 
 
909
        
1374
910
        # No such property
1375
911
        raise DBusPropertyNotFound("{}:{}.{}".format(
1376
912
            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
 
 
 
913
    
1387
914
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1388
915
                         in_signature="ss",
1389
916
                         out_signature="v")
1397
924
        if not hasattr(value, "variant_level"):
1398
925
            return value
1399
926
        return type(value)(value, variant_level=value.variant_level+1)
1400
 
 
 
927
    
1401
928
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1402
929
    def Set(self, interface_name, property_name, value):
1403
930
        """Standard D-Bus property Set() method, see D-Bus standard.
1415
942
            value = dbus.ByteArray(b''.join(chr(byte)
1416
943
                                            for byte in value))
1417
944
        prop(value)
1418
 
 
 
945
    
1419
946
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1420
947
                         in_signature="s",
1421
948
                         out_signature="a{sv}")
1422
949
    def GetAll(self, interface_name):
1423
950
        """Standard D-Bus property GetAll() method, see D-Bus
1424
951
        standard.
1425
 
 
 
952
        
1426
953
        Note: Will not include properties with access="write".
1427
954
        """
1428
955
        properties = {}
1439
966
                properties[name] = value
1440
967
                continue
1441
968
            properties[name] = type(value)(
1442
 
                value, variant_level=value.variant_level + 1)
 
969
                value, variant_level = value.variant_level + 1)
1443
970
        return dbus.Dictionary(properties, signature="sv")
1444
 
 
 
971
    
1445
972
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1446
973
    def PropertiesChanged(self, interface_name, changed_properties,
1447
974
                          invalidated_properties):
1449
976
        standard.
1450
977
        """
1451
978
        pass
1452
 
 
 
979
    
1453
980
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1454
981
                         out_signature="s",
1455
982
                         path_keyword='object_path',
1456
983
                         connection_keyword='connection')
1457
984
    def Introspect(self, object_path, connection):
1458
985
        """Overloading of standard D-Bus method.
1459
 
 
 
986
        
1460
987
        Inserts property tags and interface annotation tags.
1461
988
        """
1462
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1463
 
                                                         object_path,
1464
 
                                                         connection)
 
989
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
990
                                                   connection)
1465
991
        try:
1466
992
            document = xml.dom.minidom.parseString(xmlstring)
1467
 
 
 
993
            
1468
994
            def make_tag(document, name, prop):
1469
995
                e = document.createElement("property")
1470
996
                e.setAttribute("name", name)
1471
997
                e.setAttribute("type", prop._dbus_signature)
1472
998
                e.setAttribute("access", prop._dbus_access)
1473
999
                return e
1474
 
 
 
1000
            
1475
1001
            for if_tag in document.getElementsByTagName("interface"):
1476
1002
                # Add property tags
1477
1003
                for tag in (make_tag(document, name, prop)
1480
1006
                            if prop._dbus_interface
1481
1007
                            == if_tag.getAttribute("name")):
1482
1008
                    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)
 
1009
                # Add annotation tags
 
1010
                for typ in ("method", "signal", "property"):
 
1011
                    for tag in if_tag.getElementsByTagName(typ):
 
1012
                        annots = dict()
 
1013
                        for name, prop in (self.
 
1014
                                           _get_all_dbus_things(typ)):
 
1015
                            if (name == tag.getAttribute("name")
 
1016
                                and prop._dbus_interface
 
1017
                                == if_tag.getAttribute("name")):
 
1018
                                annots.update(getattr(
 
1019
                                    prop, "_dbus_annotations", {}))
 
1020
                        for name, value in annots.items():
 
1021
                            ann_tag = document.createElement(
 
1022
                                "annotation")
 
1023
                            ann_tag.setAttribute("name", name)
 
1024
                            ann_tag.setAttribute("value", value)
 
1025
                            tag.appendChild(ann_tag)
 
1026
                # Add interface annotation tags
 
1027
                for annotation, value in dict(
 
1028
                    itertools.chain.from_iterable(
 
1029
                        annotations().items()
 
1030
                        for name, annotations
 
1031
                        in self._get_all_dbus_things("interface")
 
1032
                        if name == if_tag.getAttribute("name")
 
1033
                        )).items():
 
1034
                    ann_tag = document.createElement("annotation")
 
1035
                    ann_tag.setAttribute("name", annotation)
 
1036
                    ann_tag.setAttribute("value", value)
 
1037
                    if_tag.appendChild(ann_tag)
1499
1038
                # Add the names to the return values for the
1500
1039
                # "org.freedesktop.DBus.Properties" methods
1501
1040
                if (if_tag.getAttribute("name")
1520
1059
        return xmlstring
1521
1060
 
1522
1061
 
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
1062
def datetime_to_dbus(dt, variant_level=0):
1595
1063
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1596
1064
    if dt is None:
1597
 
        return dbus.String("", variant_level=variant_level)
 
1065
        return dbus.String("", variant_level = variant_level)
1598
1066
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1599
1067
 
1600
1068
 
1603
1071
    dbus.service.Object, it will add alternate D-Bus attributes with
1604
1072
    interface names according to the "alt_interface_names" mapping.
1605
1073
    Usage:
1606
 
 
 
1074
    
1607
1075
    @alternate_dbus_interfaces({"org.example.Interface":
1608
1076
                                    "net.example.AlternateInterface"})
1609
1077
    class SampleDBusObject(dbus.service.Object):
1610
1078
        @dbus.service.method("org.example.Interface")
1611
1079
        def SampleDBusMethod():
1612
1080
            pass
1613
 
 
 
1081
    
1614
1082
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1615
1083
    reachable via two interfaces: "org.example.Interface" and
1616
1084
    "net.example.AlternateInterface", the latter of which will have
1617
1085
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1618
1086
    "true", unless "deprecate" is passed with a False value.
1619
 
 
 
1087
    
1620
1088
    This works for methods and signals, and also for D-Bus properties
1621
1089
    (from DBusObjectWithProperties) and interfaces (from the
1622
1090
    dbus_interface_annotations decorator).
1623
1091
    """
1624
 
 
 
1092
    
1625
1093
    def wrapper(cls):
1626
1094
        for orig_interface_name, alt_interface_name in (
1627
1095
                alt_interface_names.items()):
1642
1110
                interface_names.add(alt_interface)
1643
1111
                # Is this a D-Bus signal?
1644
1112
                if getattr(attribute, "_dbus_is_signal", False):
1645
 
                    # Extract the original non-method undecorated
1646
 
                    # function by black magic
1647
1113
                    if sys.version_info.major == 2:
 
1114
                        # Extract the original non-method undecorated
 
1115
                        # function by black magic
1648
1116
                        nonmethod_func = (dict(
1649
1117
                            zip(attribute.func_code.co_freevars,
1650
1118
                                attribute.__closure__))
1651
1119
                                          ["func"].cell_contents)
1652
1120
                    else:
1653
 
                        nonmethod_func = (dict(
1654
 
                            zip(attribute.__code__.co_freevars,
1655
 
                                attribute.__closure__))
1656
 
                                          ["func"].cell_contents)
 
1121
                        nonmethod_func = attribute
1657
1122
                    # Create a new, but exactly alike, function
1658
1123
                    # object, and decorate it to be a new D-Bus signal
1659
1124
                    # with the alternate D-Bus interface name
1660
 
                    new_function = copy_function(nonmethod_func)
 
1125
                    if sys.version_info.major == 2:
 
1126
                        new_function = types.FunctionType(
 
1127
                            nonmethod_func.func_code,
 
1128
                            nonmethod_func.func_globals,
 
1129
                            nonmethod_func.func_name,
 
1130
                            nonmethod_func.func_defaults,
 
1131
                            nonmethod_func.func_closure)
 
1132
                    else:
 
1133
                        new_function = types.FunctionType(
 
1134
                            nonmethod_func.__code__,
 
1135
                            nonmethod_func.__globals__,
 
1136
                            nonmethod_func.__name__,
 
1137
                            nonmethod_func.__defaults__,
 
1138
                            nonmethod_func.__closure__)
1661
1139
                    new_function = (dbus.service.signal(
1662
1140
                        alt_interface,
1663
1141
                        attribute._dbus_signature)(new_function))
1667
1145
                            attribute._dbus_annotations)
1668
1146
                    except AttributeError:
1669
1147
                        pass
1670
 
 
1671
1148
                    # Define a creator of a function to call both the
1672
1149
                    # original and alternate functions, so both the
1673
1150
                    # original and alternate signals gets sent when
1676
1153
                        """This function is a scope container to pass
1677
1154
                        func1 and func2 to the "call_both" function
1678
1155
                        outside of its arguments"""
1679
 
 
1680
 
                        @functools.wraps(func2)
 
1156
                        
1681
1157
                        def call_both(*args, **kwargs):
1682
1158
                            """This function will emit two D-Bus
1683
1159
                            signals by calling func1 and func2"""
1684
1160
                            func1(*args, **kwargs)
1685
1161
                            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
 
 
 
1162
                        
1692
1163
                        return call_both
1693
1164
                    # Create the "call_both" function and add it to
1694
1165
                    # the class
1704
1175
                            alt_interface,
1705
1176
                            attribute._dbus_in_signature,
1706
1177
                            attribute._dbus_out_signature)
1707
 
                        (copy_function(attribute)))
 
1178
                        (types.FunctionType(attribute.func_code,
 
1179
                                            attribute.func_globals,
 
1180
                                            attribute.func_name,
 
1181
                                            attribute.func_defaults,
 
1182
                                            attribute.func_closure)))
1708
1183
                    # Copy annotations, if any
1709
1184
                    try:
1710
1185
                        attr[attrname]._dbus_annotations = dict(
1722
1197
                        attribute._dbus_access,
1723
1198
                        attribute._dbus_get_args_options
1724
1199
                        ["byte_arrays"])
1725
 
                                      (copy_function(attribute)))
 
1200
                                      (types.FunctionType(
 
1201
                                          attribute.func_code,
 
1202
                                          attribute.func_globals,
 
1203
                                          attribute.func_name,
 
1204
                                          attribute.func_defaults,
 
1205
                                          attribute.func_closure)))
1726
1206
                    # Copy annotations, if any
1727
1207
                    try:
1728
1208
                        attr[attrname]._dbus_annotations = dict(
1737
1217
                    # to the class.
1738
1218
                    attr[attrname] = (
1739
1219
                        dbus_interface_annotations(alt_interface)
1740
 
                        (copy_function(attribute)))
 
1220
                        (types.FunctionType(attribute.func_code,
 
1221
                                            attribute.func_globals,
 
1222
                                            attribute.func_name,
 
1223
                                            attribute.func_defaults,
 
1224
                                            attribute.func_closure)))
1741
1225
            if deprecate:
1742
1226
                # Deprecate all alternate interfaces
1743
 
                iname = "_AlternateDBusNames_interface_annotation{}"
 
1227
                iname="_AlternateDBusNames_interface_annotation{}"
1744
1228
                for interface_name in interface_names:
1745
 
 
 
1229
                    
1746
1230
                    @dbus_interface_annotations(interface_name)
1747
1231
                    def func(self):
1748
 
                        return {"org.freedesktop.DBus.Deprecated":
1749
 
                                "true"}
 
1232
                        return { "org.freedesktop.DBus.Deprecated":
 
1233
                                 "true" }
1750
1234
                    # Find an unused name
1751
1235
                    for aname in (iname.format(i)
1752
1236
                                  for i in itertools.count()):
1756
1240
            if interface_names:
1757
1241
                # Replace the class with a new subclass of it with
1758
1242
                # 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)
 
1243
                cls = type(b"{}Alternate".format(cls.__name__),
 
1244
                           (cls, ), attr)
1765
1245
        return cls
1766
 
 
 
1246
    
1767
1247
    return wrapper
1768
1248
 
1769
1249
 
1771
1251
                            "se.bsnet.fukt.Mandos"})
1772
1252
class ClientDBus(Client, DBusObjectWithProperties):
1773
1253
    """A Client class using D-Bus
1774
 
 
 
1254
    
1775
1255
    Attributes:
1776
1256
    dbus_object_path: dbus.ObjectPath
1777
1257
    bus: dbus.SystemBus()
1778
1258
    """
1779
 
 
 
1259
    
1780
1260
    runtime_expansions = (Client.runtime_expansions
1781
1261
                          + ("dbus_object_path", ))
1782
 
 
 
1262
    
1783
1263
    _interface = "se.recompile.Mandos.Client"
1784
 
 
 
1264
    
1785
1265
    # dbus.service.Object doesn't use super(), so we can't either.
1786
 
 
1787
 
    def __init__(self, bus=None, *args, **kwargs):
 
1266
    
 
1267
    def __init__(self, bus = None, *args, **kwargs):
1788
1268
        self.bus = bus
1789
1269
        Client.__init__(self, *args, **kwargs)
1790
1270
        # Only now, when this client is initialized, can it show up on
1796
1276
            "/clients/" + client_object_name)
1797
1277
        DBusObjectWithProperties.__init__(self, self.bus,
1798
1278
                                          self.dbus_object_path)
1799
 
 
 
1279
    
1800
1280
    def notifychangeproperty(transform_func, dbus_name,
1801
1281
                             type_func=lambda x: x,
1802
1282
                             variant_level=1,
1804
1284
                             _interface=_interface):
1805
1285
        """ Modify a variable so that it's a property which announces
1806
1286
        its changes to DBus.
1807
 
 
 
1287
        
1808
1288
        transform_fun: Function that takes a value and a variant_level
1809
1289
                       and transforms it to a D-Bus type.
1810
1290
        dbus_name: D-Bus name of the variable
1813
1293
        variant_level: D-Bus variant level.  Default: 1
1814
1294
        """
1815
1295
        attrname = "_{}".format(dbus_name)
1816
 
 
 
1296
        
1817
1297
        def setter(self, value):
1818
1298
            if hasattr(self, "dbus_object_path"):
1819
1299
                if (not hasattr(self, attrname) or
1826
1306
                    else:
1827
1307
                        dbus_value = transform_func(
1828
1308
                            type_func(value),
1829
 
                            variant_level=variant_level)
 
1309
                            variant_level = variant_level)
1830
1310
                        self.PropertyChanged(dbus.String(dbus_name),
1831
1311
                                             dbus_value)
1832
1312
                        self.PropertiesChanged(
1833
1313
                            _interface,
1834
 
                            dbus.Dictionary({dbus.String(dbus_name):
1835
 
                                             dbus_value}),
 
1314
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1315
                                              dbus_value }),
1836
1316
                            dbus.Array())
1837
1317
            setattr(self, attrname, value)
1838
 
 
 
1318
        
1839
1319
        return property(lambda self: getattr(self, attrname), setter)
1840
 
 
 
1320
    
1841
1321
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1842
1322
    approvals_pending = notifychangeproperty(dbus.Boolean,
1843
1323
                                             "ApprovalPending",
1844
 
                                             type_func=bool)
 
1324
                                             type_func = bool)
1845
1325
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1846
1326
    last_enabled = notifychangeproperty(datetime_to_dbus,
1847
1327
                                        "LastEnabled")
1848
1328
    checker = notifychangeproperty(
1849
1329
        dbus.Boolean, "CheckerRunning",
1850
 
        type_func=lambda checker: checker is not None)
 
1330
        type_func = lambda checker: checker is not None)
1851
1331
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1852
1332
                                           "LastCheckedOK")
1853
1333
    last_checker_status = notifychangeproperty(dbus.Int16,
1858
1338
                                               "ApprovedByDefault")
1859
1339
    approval_delay = notifychangeproperty(
1860
1340
        dbus.UInt64, "ApprovalDelay",
1861
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1341
        type_func = lambda td: td.total_seconds() * 1000)
1862
1342
    approval_duration = notifychangeproperty(
1863
1343
        dbus.UInt64, "ApprovalDuration",
1864
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1344
        type_func = lambda td: td.total_seconds() * 1000)
1865
1345
    host = notifychangeproperty(dbus.String, "Host")
1866
1346
    timeout = notifychangeproperty(
1867
1347
        dbus.UInt64, "Timeout",
1868
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1348
        type_func = lambda td: td.total_seconds() * 1000)
1869
1349
    extended_timeout = notifychangeproperty(
1870
1350
        dbus.UInt64, "ExtendedTimeout",
1871
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1351
        type_func = lambda td: td.total_seconds() * 1000)
1872
1352
    interval = notifychangeproperty(
1873
1353
        dbus.UInt64, "Interval",
1874
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1354
        type_func = lambda td: td.total_seconds() * 1000)
1875
1355
    checker_command = notifychangeproperty(dbus.String, "Checker")
1876
1356
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1877
1357
                                  invalidate_only=True)
1878
 
 
 
1358
    
1879
1359
    del notifychangeproperty
1880
 
 
 
1360
    
1881
1361
    def __del__(self, *args, **kwargs):
1882
1362
        try:
1883
1363
            self.remove_from_connection()
1886
1366
        if hasattr(DBusObjectWithProperties, "__del__"):
1887
1367
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1888
1368
        Client.__del__(self, *args, **kwargs)
1889
 
 
 
1369
    
1890
1370
    def checker_callback(self, source, condition,
1891
1371
                         connection, command, *args, **kwargs):
1892
1372
        ret = Client.checker_callback(self, source, condition,
1896
1376
        if exitstatus >= 0:
1897
1377
            # Emit D-Bus signal
1898
1378
            self.CheckerCompleted(dbus.Int16(exitstatus),
1899
 
                                  # This is specific to GNU libC
1900
 
                                  dbus.Int64(exitstatus << 8),
 
1379
                                  dbus.Int64(0),
1901
1380
                                  dbus.String(command))
1902
1381
        else:
1903
1382
            # Emit D-Bus signal
1904
1383
            self.CheckerCompleted(dbus.Int16(-1),
1905
1384
                                  dbus.Int64(
1906
 
                                      # This is specific to GNU libC
1907
 
                                      (exitstatus << 8)
1908
 
                                      | self.last_checker_signal),
 
1385
                                      self.last_checker_signal),
1909
1386
                                  dbus.String(command))
1910
1387
        return ret
1911
 
 
 
1388
    
1912
1389
    def start_checker(self, *args, **kwargs):
1913
1390
        old_checker_pid = getattr(self.checker, "pid", None)
1914
1391
        r = Client.start_checker(self, *args, **kwargs)
1918
1395
            # Emit D-Bus signal
1919
1396
            self.CheckerStarted(self.current_checker_command)
1920
1397
        return r
1921
 
 
 
1398
    
1922
1399
    def _reset_approved(self):
1923
1400
        self.approved = None
1924
1401
        return False
1925
 
 
 
1402
    
1926
1403
    def approve(self, value=True):
1927
1404
        self.approved = value
1928
 
        GLib.timeout_add(int(self.approval_duration.total_seconds()
1929
 
                             * 1000), self._reset_approved)
 
1405
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1406
                                * 1000), self._reset_approved)
1930
1407
        self.send_changedstate()
1931
 
 
1932
 
    #  D-Bus methods, signals & properties
1933
 
 
1934
 
    #  Interfaces
1935
 
 
1936
 
    #  Signals
1937
 
 
 
1408
    
 
1409
    ## D-Bus methods, signals & properties
 
1410
    
 
1411
    ## Interfaces
 
1412
    
 
1413
    ## Signals
 
1414
    
1938
1415
    # CheckerCompleted - signal
1939
1416
    @dbus.service.signal(_interface, signature="nxs")
1940
1417
    def CheckerCompleted(self, exitcode, waitstatus, command):
1941
1418
        "D-Bus signal"
1942
1419
        pass
1943
 
 
 
1420
    
1944
1421
    # CheckerStarted - signal
1945
1422
    @dbus.service.signal(_interface, signature="s")
1946
1423
    def CheckerStarted(self, command):
1947
1424
        "D-Bus signal"
1948
1425
        pass
1949
 
 
 
1426
    
1950
1427
    # PropertyChanged - signal
1951
1428
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1952
1429
    @dbus.service.signal(_interface, signature="sv")
1953
1430
    def PropertyChanged(self, property, value):
1954
1431
        "D-Bus signal"
1955
1432
        pass
1956
 
 
 
1433
    
1957
1434
    # GotSecret - signal
1958
1435
    @dbus.service.signal(_interface)
1959
1436
    def GotSecret(self):
1962
1439
        server to mandos-client
1963
1440
        """
1964
1441
        pass
1965
 
 
 
1442
    
1966
1443
    # Rejected - signal
1967
1444
    @dbus.service.signal(_interface, signature="s")
1968
1445
    def Rejected(self, reason):
1969
1446
        "D-Bus signal"
1970
1447
        pass
1971
 
 
 
1448
    
1972
1449
    # NeedApproval - signal
1973
1450
    @dbus.service.signal(_interface, signature="tb")
1974
1451
    def NeedApproval(self, timeout, default):
1975
1452
        "D-Bus signal"
1976
1453
        return self.need_approval()
1977
 
 
1978
 
    #  Methods
1979
 
 
 
1454
    
 
1455
    ## Methods
 
1456
    
1980
1457
    # Approve - method
1981
1458
    @dbus.service.method(_interface, in_signature="b")
1982
1459
    def Approve(self, value):
1983
1460
        self.approve(value)
1984
 
 
 
1461
    
1985
1462
    # CheckedOK - method
1986
1463
    @dbus.service.method(_interface)
1987
1464
    def CheckedOK(self):
1988
1465
        self.checked_ok()
1989
 
 
 
1466
    
1990
1467
    # Enable - method
1991
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1992
1468
    @dbus.service.method(_interface)
1993
1469
    def Enable(self):
1994
1470
        "D-Bus method"
1995
1471
        self.enable()
1996
 
 
 
1472
    
1997
1473
    # StartChecker - method
1998
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1999
1474
    @dbus.service.method(_interface)
2000
1475
    def StartChecker(self):
2001
1476
        "D-Bus method"
2002
1477
        self.start_checker()
2003
 
 
 
1478
    
2004
1479
    # Disable - method
2005
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2006
1480
    @dbus.service.method(_interface)
2007
1481
    def Disable(self):
2008
1482
        "D-Bus method"
2009
1483
        self.disable()
2010
 
 
 
1484
    
2011
1485
    # StopChecker - method
2012
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2013
1486
    @dbus.service.method(_interface)
2014
1487
    def StopChecker(self):
2015
1488
        self.stop_checker()
2016
 
 
2017
 
    #  Properties
2018
 
 
 
1489
    
 
1490
    ## Properties
 
1491
    
2019
1492
    # ApprovalPending - property
2020
1493
    @dbus_service_property(_interface, signature="b", access="read")
2021
1494
    def ApprovalPending_dbus_property(self):
2022
1495
        return dbus.Boolean(bool(self.approvals_pending))
2023
 
 
 
1496
    
2024
1497
    # ApprovedByDefault - property
2025
1498
    @dbus_service_property(_interface,
2026
1499
                           signature="b",
2029
1502
        if value is None:       # get
2030
1503
            return dbus.Boolean(self.approved_by_default)
2031
1504
        self.approved_by_default = bool(value)
2032
 
 
 
1505
    
2033
1506
    # ApprovalDelay - property
2034
1507
    @dbus_service_property(_interface,
2035
1508
                           signature="t",
2039
1512
            return dbus.UInt64(self.approval_delay.total_seconds()
2040
1513
                               * 1000)
2041
1514
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
2042
 
 
 
1515
    
2043
1516
    # ApprovalDuration - property
2044
1517
    @dbus_service_property(_interface,
2045
1518
                           signature="t",
2049
1522
            return dbus.UInt64(self.approval_duration.total_seconds()
2050
1523
                               * 1000)
2051
1524
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
2052
 
 
 
1525
    
2053
1526
    # Name - property
2054
 
    @dbus_annotations(
2055
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2056
1527
    @dbus_service_property(_interface, signature="s", access="read")
2057
1528
    def Name_dbus_property(self):
2058
1529
        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
 
 
 
1530
    
2067
1531
    # Fingerprint - property
2068
 
    @dbus_annotations(
2069
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
1532
    @dbus_service_property(_interface, signature="s", access="read")
2071
1533
    def Fingerprint_dbus_property(self):
2072
1534
        return dbus.String(self.fingerprint)
2073
 
 
 
1535
    
2074
1536
    # Host - property
2075
1537
    @dbus_service_property(_interface,
2076
1538
                           signature="s",
2079
1541
        if value is None:       # get
2080
1542
            return dbus.String(self.host)
2081
1543
        self.host = str(value)
2082
 
 
 
1544
    
2083
1545
    # Created - property
2084
 
    @dbus_annotations(
2085
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
1546
    @dbus_service_property(_interface, signature="s", access="read")
2087
1547
    def Created_dbus_property(self):
2088
1548
        return datetime_to_dbus(self.created)
2089
 
 
 
1549
    
2090
1550
    # LastEnabled - property
2091
1551
    @dbus_service_property(_interface, signature="s", access="read")
2092
1552
    def LastEnabled_dbus_property(self):
2093
1553
        return datetime_to_dbus(self.last_enabled)
2094
 
 
 
1554
    
2095
1555
    # Enabled - property
2096
1556
    @dbus_service_property(_interface,
2097
1557
                           signature="b",
2103
1563
            self.enable()
2104
1564
        else:
2105
1565
            self.disable()
2106
 
 
 
1566
    
2107
1567
    # LastCheckedOK - property
2108
1568
    @dbus_service_property(_interface,
2109
1569
                           signature="s",
2113
1573
            self.checked_ok()
2114
1574
            return
2115
1575
        return datetime_to_dbus(self.last_checked_ok)
2116
 
 
 
1576
    
2117
1577
    # LastCheckerStatus - property
2118
1578
    @dbus_service_property(_interface, signature="n", access="read")
2119
1579
    def LastCheckerStatus_dbus_property(self):
2120
1580
        return dbus.Int16(self.last_checker_status)
2121
 
 
 
1581
    
2122
1582
    # Expires - property
2123
1583
    @dbus_service_property(_interface, signature="s", access="read")
2124
1584
    def Expires_dbus_property(self):
2125
1585
        return datetime_to_dbus(self.expires)
2126
 
 
 
1586
    
2127
1587
    # LastApprovalRequest - property
2128
1588
    @dbus_service_property(_interface, signature="s", access="read")
2129
1589
    def LastApprovalRequest_dbus_property(self):
2130
1590
        return datetime_to_dbus(self.last_approval_request)
2131
 
 
 
1591
    
2132
1592
    # Timeout - property
2133
1593
    @dbus_service_property(_interface,
2134
1594
                           signature="t",
2149
1609
                if (getattr(self, "disable_initiator_tag", None)
2150
1610
                    is None):
2151
1611
                    return
2152
 
                GLib.source_remove(self.disable_initiator_tag)
2153
 
                self.disable_initiator_tag = GLib.timeout_add(
 
1612
                gobject.source_remove(self.disable_initiator_tag)
 
1613
                self.disable_initiator_tag = gobject.timeout_add(
2154
1614
                    int((self.expires - now).total_seconds() * 1000),
2155
1615
                    self.disable)
2156
 
 
 
1616
    
2157
1617
    # ExtendedTimeout - property
2158
1618
    @dbus_service_property(_interface,
2159
1619
                           signature="t",
2163
1623
            return dbus.UInt64(self.extended_timeout.total_seconds()
2164
1624
                               * 1000)
2165
1625
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2166
 
 
 
1626
    
2167
1627
    # Interval - property
2168
1628
    @dbus_service_property(_interface,
2169
1629
                           signature="t",
2176
1636
            return
2177
1637
        if self.enabled:
2178
1638
            # Reschedule checker run
2179
 
            GLib.source_remove(self.checker_initiator_tag)
2180
 
            self.checker_initiator_tag = GLib.timeout_add(
 
1639
            gobject.source_remove(self.checker_initiator_tag)
 
1640
            self.checker_initiator_tag = gobject.timeout_add(
2181
1641
                value, self.start_checker)
2182
 
            self.start_checker()  # Start one now, too
2183
 
 
 
1642
            self.start_checker() # Start one now, too
 
1643
    
2184
1644
    # Checker - property
2185
1645
    @dbus_service_property(_interface,
2186
1646
                           signature="s",
2189
1649
        if value is None:       # get
2190
1650
            return dbus.String(self.checker_command)
2191
1651
        self.checker_command = str(value)
2192
 
 
 
1652
    
2193
1653
    # CheckerRunning - property
2194
1654
    @dbus_service_property(_interface,
2195
1655
                           signature="b",
2201
1661
            self.start_checker()
2202
1662
        else:
2203
1663
            self.stop_checker()
2204
 
 
 
1664
    
2205
1665
    # ObjectPath - property
2206
 
    @dbus_annotations(
2207
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2208
 
         "org.freedesktop.DBus.Deprecated": "true"})
2209
1666
    @dbus_service_property(_interface, signature="o", access="read")
2210
1667
    def ObjectPath_dbus_property(self):
2211
 
        return self.dbus_object_path  # is already a dbus.ObjectPath
2212
 
 
 
1668
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1669
    
2213
1670
    # Secret = property
2214
 
    @dbus_annotations(
2215
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
2216
 
         "invalidates"})
2217
1671
    @dbus_service_property(_interface,
2218
1672
                           signature="ay",
2219
1673
                           access="write",
2220
1674
                           byte_arrays=True)
2221
1675
    def Secret_dbus_property(self, value):
2222
1676
        self.secret = bytes(value)
2223
 
 
 
1677
    
2224
1678
    del _interface
2225
1679
 
2226
1680
 
2227
 
class ProxyClient:
2228
 
    def __init__(self, child_pipe, key_id, fpr, address):
 
1681
class ProxyClient(object):
 
1682
    def __init__(self, child_pipe, fpr, address):
2229
1683
        self._pipe = child_pipe
2230
 
        self._pipe.send(('init', key_id, fpr, address))
 
1684
        self._pipe.send(('init', fpr, address))
2231
1685
        if not self._pipe.recv():
2232
 
            raise KeyError(key_id or fpr)
2233
 
 
 
1686
            raise KeyError(fpr)
 
1687
    
2234
1688
    def __getattribute__(self, name):
2235
1689
        if name == '_pipe':
2236
1690
            return super(ProxyClient, self).__getattribute__(name)
2239
1693
        if data[0] == 'data':
2240
1694
            return data[1]
2241
1695
        if data[0] == 'function':
2242
 
 
 
1696
            
2243
1697
            def func(*args, **kwargs):
2244
1698
                self._pipe.send(('funcall', name, args, kwargs))
2245
1699
                return self._pipe.recv()[1]
2246
 
 
 
1700
            
2247
1701
            return func
2248
 
 
 
1702
    
2249
1703
    def __setattr__(self, name, value):
2250
1704
        if name == '_pipe':
2251
1705
            return super(ProxyClient, self).__setattr__(name, value)
2254
1708
 
2255
1709
class ClientHandler(socketserver.BaseRequestHandler, object):
2256
1710
    """A class to handle client connections.
2257
 
 
 
1711
    
2258
1712
    Instantiated once for each connection to handle it.
2259
1713
    Note: This will run in its own forked process."""
2260
 
 
 
1714
    
2261
1715
    def handle(self):
2262
1716
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2263
1717
            logger.info("TCP connection from: %s",
2264
1718
                        str(self.client_address))
2265
1719
            logger.debug("Pipe FD: %d",
2266
1720
                         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"))
 
1721
            
 
1722
            session = gnutls.connection.ClientSession(
 
1723
                self.request, gnutls.connection .X509Credentials())
 
1724
            
 
1725
            # Note: gnutls.connection.X509Credentials is really a
 
1726
            # generic GnuTLS certificate credentials object so long as
 
1727
            # no X.509 keys are added to it.  Therefore, we can use it
 
1728
            # here despite using OpenPGP certificates.
 
1729
            
 
1730
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1731
            #                      "+AES-256-CBC", "+SHA1",
 
1732
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1733
            #                      "+DHE-DSS"))
2274
1734
            # Use a fallback default, since this MUST be set.
2275
1735
            priority = self.server.gnutls_priority
2276
1736
            if priority is None:
2277
1737
                priority = "NORMAL"
2278
 
            gnutls.priority_set_direct(session._c_object,
2279
 
                                       priority.encode("utf-8"),
2280
 
                                       None)
2281
 
 
 
1738
            gnutls.library.functions.gnutls_priority_set_direct(
 
1739
                session._c_object, priority, None)
 
1740
            
2282
1741
            # Start communication using the Mandos protocol
2283
1742
            # Get protocol number
2284
1743
            line = self.request.makefile().readline()
2289
1748
            except (ValueError, IndexError, RuntimeError) as error:
2290
1749
                logger.error("Unknown protocol version: %s", error)
2291
1750
                return
2292
 
 
 
1751
            
2293
1752
            # Start GnuTLS connection
2294
1753
            try:
2295
1754
                session.handshake()
2296
 
            except gnutls.Error as error:
 
1755
            except gnutls.errors.GNUTLSError as error:
2297
1756
                logger.warning("Handshake failed: %s", error)
2298
1757
                # Do not run session.bye() here: the session is not
2299
1758
                # established.  Just abandon the request.
2300
1759
                return
2301
1760
            logger.debug("Handshake succeeded")
2302
 
 
 
1761
            
2303
1762
            approval_required = False
2304
1763
            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,
 
1764
                try:
 
1765
                    fpr = self.fingerprint(
 
1766
                        self.peer_certificate(session))
 
1767
                except (TypeError,
 
1768
                        gnutls.errors.GNUTLSError) as error:
 
1769
                    logger.warning("Bad certificate: %s", error)
 
1770
                    return
 
1771
                logger.debug("Fingerprint: %s", fpr)
 
1772
                
 
1773
                try:
 
1774
                    client = ProxyClient(child_pipe, fpr,
2327
1775
                                         self.client_address)
2328
1776
                except KeyError:
2329
1777
                    return
2330
 
 
 
1778
                
2331
1779
                if client.approval_delay:
2332
1780
                    delay = client.approval_delay
2333
1781
                    client.approvals_pending += 1
2334
1782
                    approval_required = True
2335
 
 
 
1783
                
2336
1784
                while True:
2337
1785
                    if not client.enabled:
2338
1786
                        logger.info("Client %s is disabled",
2341
1789
                            # Emit D-Bus signal
2342
1790
                            client.Rejected("Disabled")
2343
1791
                        return
2344
 
 
 
1792
                    
2345
1793
                    if client.approved or not client.approval_delay:
2346
 
                        # We are approved or approval is disabled
 
1794
                        #We are approved or approval is disabled
2347
1795
                        break
2348
1796
                    elif client.approved is None:
2349
1797
                        logger.info("Client %s needs approval",
2360
1808
                            # Emit D-Bus signal
2361
1809
                            client.Rejected("Denied")
2362
1810
                        return
2363
 
 
2364
 
                    # wait until timeout or approved
 
1811
                    
 
1812
                    #wait until timeout or approved
2365
1813
                    time = datetime.datetime.now()
2366
1814
                    client.changedstate.acquire()
2367
1815
                    client.changedstate.wait(delay.total_seconds())
2380
1828
                            break
2381
1829
                    else:
2382
1830
                        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
 
 
 
1831
                
 
1832
                sent_size = 0
 
1833
                while sent_size < len(client.secret):
 
1834
                    try:
 
1835
                        sent = session.send(client.secret[sent_size:])
 
1836
                    except gnutls.errors.GNUTLSError as error:
 
1837
                        logger.warning("gnutls send failed",
 
1838
                                       exc_info=error)
 
1839
                        return
 
1840
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1841
                                 len(client.secret) - (sent_size
 
1842
                                                       + sent))
 
1843
                    sent_size += sent
 
1844
                
2391
1845
                logger.info("Sending secret to %s", client.name)
2392
1846
                # bump the timeout using extended_timeout
2393
1847
                client.bump_timeout(client.extended_timeout)
2394
1848
                if self.server.use_dbus:
2395
1849
                    # Emit D-Bus signal
2396
1850
                    client.GotSecret()
2397
 
 
 
1851
            
2398
1852
            finally:
2399
1853
                if approval_required:
2400
1854
                    client.approvals_pending -= 1
2401
1855
                try:
2402
1856
                    session.bye()
2403
 
                except gnutls.Error as error:
 
1857
                except gnutls.errors.GNUTLSError as error:
2404
1858
                    logger.warning("GnuTLS bye failed",
2405
1859
                                   exc_info=error)
2406
 
 
 
1860
    
2407
1861
    @staticmethod
2408
1862
    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""
 
1863
        "Return the peer's OpenPGP certificate as a bytestring"
 
1864
        # If not an OpenPGP certificate...
 
1865
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1866
                session._c_object)
 
1867
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1868
            # ...do the normal thing
 
1869
            return session.peer_certificate
2425
1870
        list_size = ctypes.c_uint(1)
2426
 
        cert_list = (gnutls.certificate_get_peers
 
1871
        cert_list = (gnutls.library.functions
 
1872
                     .gnutls_certificate_get_peers
2427
1873
                     (session._c_object, ctypes.byref(list_size)))
2428
1874
        if not bool(cert_list) and list_size.value != 0:
2429
 
            raise gnutls.Error("error getting peer certificate")
 
1875
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1876
                                            " certificate")
2430
1877
        if list_size.value == 0:
2431
1878
            return None
2432
1879
        cert = cert_list[0]
2433
1880
        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
 
 
 
1881
    
2469
1882
    @staticmethod
2470
1883
    def fingerprint(openpgp):
2471
1884
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2472
1885
        # New GnuTLS "datum" with the OpenPGP public key
2473
 
        datum = gnutls.datum_t(
 
1886
        datum = gnutls.library.types.gnutls_datum_t(
2474
1887
            ctypes.cast(ctypes.c_char_p(openpgp),
2475
1888
                        ctypes.POINTER(ctypes.c_ubyte)),
2476
1889
            ctypes.c_uint(len(openpgp)))
2477
1890
        # New empty GnuTLS certificate
2478
 
        crt = gnutls.openpgp_crt_t()
2479
 
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
1891
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1892
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1893
            ctypes.byref(crt))
2480
1894
        # Import the OpenPGP public key into the certificate
2481
 
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2482
 
                                  gnutls.OPENPGP_FMT_RAW)
 
1895
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
1896
            crt, ctypes.byref(datum),
 
1897
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
2483
1898
        # Verify the self signature in the key
2484
1899
        crtverify = ctypes.c_uint()
2485
 
        gnutls.openpgp_crt_verify_self(crt, 0,
2486
 
                                       ctypes.byref(crtverify))
 
1900
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1901
            crt, 0, ctypes.byref(crtverify))
2487
1902
        if crtverify.value != 0:
2488
 
            gnutls.openpgp_crt_deinit(crt)
2489
 
            raise gnutls.CertificateSecurityError(code
2490
 
                                                  =crtverify.value)
 
1903
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1904
            raise gnutls.errors.CertificateSecurityError(
 
1905
                "Verify failed")
2491
1906
        # New buffer for the fingerprint
2492
1907
        buf = ctypes.create_string_buffer(20)
2493
1908
        buf_len = ctypes.c_size_t()
2494
1909
        # Get the fingerprint from the certificate into the buffer
2495
 
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2496
 
                                           ctypes.byref(buf_len))
 
1910
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1911
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
2497
1912
        # Deinit the certificate
2498
 
        gnutls.openpgp_crt_deinit(crt)
 
1913
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2499
1914
        # Convert the buffer to a Python bytestring
2500
1915
        fpr = ctypes.string_at(buf, buf_len.value)
2501
1916
        # Convert the bytestring to hexadecimal notation
2503
1918
        return hex_fpr
2504
1919
 
2505
1920
 
2506
 
class MultiprocessingMixIn:
 
1921
class MultiprocessingMixIn(object):
2507
1922
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2508
 
 
 
1923
    
2509
1924
    def sub_process_main(self, request, address):
2510
1925
        try:
2511
1926
            self.finish_request(request, address)
2512
1927
        except Exception:
2513
1928
            self.handle_error(request, address)
2514
1929
        self.close_request(request)
2515
 
 
 
1930
    
2516
1931
    def process_request(self, request, address):
2517
1932
        """Start a new process to process the request."""
2518
 
        proc = multiprocessing.Process(target=self.sub_process_main,
2519
 
                                       args=(request, address))
 
1933
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1934
                                       args = (request, address))
2520
1935
        proc.start()
2521
1936
        return proc
2522
1937
 
2523
1938
 
2524
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
1939
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2525
1940
    """ adds a pipe to the MixIn """
2526
 
 
 
1941
    
2527
1942
    def process_request(self, request, client_address):
2528
1943
        """Overrides and wraps the original process_request().
2529
 
 
 
1944
        
2530
1945
        This function creates a new pipe in self.pipe
2531
1946
        """
2532
1947
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
2533
 
 
 
1948
        
2534
1949
        proc = MultiprocessingMixIn.process_request(self, request,
2535
1950
                                                    client_address)
2536
1951
        self.child_pipe.close()
2537
1952
        self.add_pipe(parent_pipe, proc)
2538
 
 
 
1953
    
2539
1954
    def add_pipe(self, parent_pipe, proc):
2540
1955
        """Dummy function; override as necessary"""
2541
1956
        raise NotImplementedError()
2542
1957
 
2543
1958
 
2544
1959
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2545
 
                     socketserver.TCPServer):
 
1960
                     socketserver.TCPServer, object):
2546
1961
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2547
 
 
 
1962
    
2548
1963
    Attributes:
2549
1964
        enabled:        Boolean; whether this server is activated yet
2550
1965
        interface:      None or a network interface name (string)
2551
1966
        use_ipv6:       Boolean; to use IPv6 or not
2552
1967
    """
2553
 
 
 
1968
    
2554
1969
    def __init__(self, server_address, RequestHandlerClass,
2555
1970
                 interface=None,
2556
1971
                 use_ipv6=True,
2566
1981
            self.socketfd = socketfd
2567
1982
            # Save the original socket.socket() function
2568
1983
            self.socket_socket = socket.socket
2569
 
 
2570
1984
            # To implement --socket, we monkey patch socket.socket.
2571
 
            #
 
1985
            # 
2572
1986
            # (When socketserver.TCPServer is a new-style class, we
2573
1987
            # could make self.socket into a property instead of monkey
2574
1988
            # patching socket.socket.)
2575
 
            #
 
1989
            # 
2576
1990
            # Create a one-time-only replacement for socket.socket()
2577
1991
            @functools.wraps(socket.socket)
2578
1992
            def socket_wrapper(*args, **kwargs):
2590
2004
        # socket_wrapper(), if socketfd was set.
2591
2005
        socketserver.TCPServer.__init__(self, server_address,
2592
2006
                                        RequestHandlerClass)
2593
 
 
 
2007
    
2594
2008
    def server_bind(self):
2595
2009
        """This overrides the normal server_bind() function
2596
2010
        to bind to an interface if one was specified, and also NOT to
2597
2011
        bind to an address or port if they were not specified."""
2598
 
        global SO_BINDTODEVICE
2599
2012
        if self.interface is not None:
2600
2013
            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
 
2014
                logger.error("SO_BINDTODEVICE does not exist;"
 
2015
                             " cannot bind to interface %s",
 
2016
                             self.interface)
 
2017
            else:
 
2018
                try:
 
2019
                    self.socket.setsockopt(
 
2020
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2021
                        (self.interface + "\0").encode("utf-8"))
 
2022
                except socket.error as error:
 
2023
                    if error.errno == errno.EPERM:
 
2024
                        logger.error("No permission to bind to"
 
2025
                                     " interface %s", self.interface)
 
2026
                    elif error.errno == errno.ENOPROTOOPT:
 
2027
                        logger.error("SO_BINDTODEVICE not available;"
 
2028
                                     " cannot bind to interface %s",
 
2029
                                     self.interface)
 
2030
                    elif error.errno == errno.ENODEV:
 
2031
                        logger.error("Interface %s does not exist,"
 
2032
                                     " cannot bind", self.interface)
 
2033
                    else:
 
2034
                        raise
2622
2035
        # Only bind(2) the socket if we really need to.
2623
2036
        if self.server_address[0] or self.server_address[1]:
2624
 
            if self.server_address[1]:
2625
 
                self.allow_reuse_address = True
2626
2037
            if not self.server_address[0]:
2627
2038
                if self.address_family == socket.AF_INET6:
2628
 
                    any_address = "::"  # in6addr_any
 
2039
                    any_address = "::" # in6addr_any
2629
2040
                else:
2630
 
                    any_address = "0.0.0.0"  # INADDR_ANY
 
2041
                    any_address = "0.0.0.0" # INADDR_ANY
2631
2042
                self.server_address = (any_address,
2632
2043
                                       self.server_address[1])
2633
2044
            elif not self.server_address[1]:
2643
2054
 
2644
2055
class MandosServer(IPv6_TCPServer):
2645
2056
    """Mandos server.
2646
 
 
 
2057
    
2647
2058
    Attributes:
2648
2059
        clients:        set of Client objects
2649
2060
        gnutls_priority GnuTLS priority string
2650
2061
        use_dbus:       Boolean; to emit D-Bus signals or not
2651
 
 
2652
 
    Assumes a GLib.MainLoop event loop.
 
2062
    
 
2063
    Assumes a gobject.MainLoop event loop.
2653
2064
    """
2654
 
 
 
2065
    
2655
2066
    def __init__(self, server_address, RequestHandlerClass,
2656
2067
                 interface=None,
2657
2068
                 use_ipv6=True,
2667
2078
        self.gnutls_priority = gnutls_priority
2668
2079
        IPv6_TCPServer.__init__(self, server_address,
2669
2080
                                RequestHandlerClass,
2670
 
                                interface=interface,
2671
 
                                use_ipv6=use_ipv6,
2672
 
                                socketfd=socketfd)
2673
 
 
 
2081
                                interface = interface,
 
2082
                                use_ipv6 = use_ipv6,
 
2083
                                socketfd = socketfd)
 
2084
    
2674
2085
    def server_activate(self):
2675
2086
        if self.enabled:
2676
2087
            return socketserver.TCPServer.server_activate(self)
2677
 
 
 
2088
    
2678
2089
    def enable(self):
2679
2090
        self.enabled = True
2680
 
 
 
2091
    
2681
2092
    def add_pipe(self, parent_pipe, proc):
2682
2093
        # 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,
 
2094
        gobject.io_add_watch(
 
2095
            parent_pipe.fileno(),
 
2096
            gobject.IO_IN | gobject.IO_HUP,
2686
2097
            functools.partial(self.handle_ipc,
2687
 
                              parent_pipe=parent_pipe,
2688
 
                              proc=proc))
2689
 
 
 
2098
                              parent_pipe = parent_pipe,
 
2099
                              proc = proc))
 
2100
    
2690
2101
    def handle_ipc(self, source, condition,
2691
2102
                   parent_pipe=None,
2692
 
                   proc=None,
 
2103
                   proc = None,
2693
2104
                   client_object=None):
2694
2105
        # error, or the other end of multiprocessing.Pipe has closed
2695
 
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
 
2106
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2696
2107
            # Wait for other process to exit
2697
2108
            proc.join()
2698
2109
            return False
2699
 
 
 
2110
        
2700
2111
        # Read a request from the child
2701
2112
        request = parent_pipe.recv()
2702
2113
        command = request[0]
2703
 
 
 
2114
        
2704
2115
        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:
 
2116
            fpr = request[1]
 
2117
            address = request[2]
 
2118
            
 
2119
            for c in self.clients.itervalues():
 
2120
                if c.fingerprint == fpr:
2716
2121
                    client = c
2717
2122
                    break
2718
2123
            else:
2719
 
                logger.info("Client not found for key ID: %s, address"
2720
 
                            ": %s", key_id or fpr, address)
 
2124
                logger.info("Client not found for fingerprint: %s, ad"
 
2125
                            "dress: %s", fpr, address)
2721
2126
                if self.use_dbus:
2722
2127
                    # Emit D-Bus signal
2723
 
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
 
2128
                    mandos_dbus_service.ClientNotFound(fpr,
2724
2129
                                                       address[0])
2725
2130
                parent_pipe.send(False)
2726
2131
                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,
 
2132
            
 
2133
            gobject.io_add_watch(
 
2134
                parent_pipe.fileno(),
 
2135
                gobject.IO_IN | gobject.IO_HUP,
2731
2136
                functools.partial(self.handle_ipc,
2732
 
                                  parent_pipe=parent_pipe,
2733
 
                                  proc=proc,
2734
 
                                  client_object=client))
 
2137
                                  parent_pipe = parent_pipe,
 
2138
                                  proc = proc,
 
2139
                                  client_object = client))
2735
2140
            parent_pipe.send(True)
2736
2141
            # remove the old hook in favor of the new above hook on
2737
2142
            # same fileno
2740
2145
            funcname = request[1]
2741
2146
            args = request[2]
2742
2147
            kwargs = request[3]
2743
 
 
 
2148
            
2744
2149
            parent_pipe.send(('data', getattr(client_object,
2745
2150
                                              funcname)(*args,
2746
2151
                                                        **kwargs)))
2747
 
 
 
2152
        
2748
2153
        if command == 'getattr':
2749
2154
            attrname = request[1]
2750
2155
            if isinstance(client_object.__getattribute__(attrname),
2753
2158
            else:
2754
2159
                parent_pipe.send((
2755
2160
                    'data', client_object.__getattribute__(attrname)))
2756
 
 
 
2161
        
2757
2162
        if command == 'setattr':
2758
2163
            attrname = request[1]
2759
2164
            value = request[2]
2760
2165
            setattr(client_object, attrname, value)
2761
 
 
 
2166
        
2762
2167
        return True
2763
2168
 
2764
2169
 
2765
2170
def rfc3339_duration_to_delta(duration):
2766
2171
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2767
 
 
2768
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2769
 
    True
2770
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2771
 
    True
2772
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2773
 
    True
2774
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2775
 
    True
2776
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2777
 
    True
2778
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2779
 
    True
2780
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2781
 
    True
 
2172
    
 
2173
    >>> rfc3339_duration_to_delta("P7D")
 
2174
    datetime.timedelta(7)
 
2175
    >>> rfc3339_duration_to_delta("PT60S")
 
2176
    datetime.timedelta(0, 60)
 
2177
    >>> rfc3339_duration_to_delta("PT60M")
 
2178
    datetime.timedelta(0, 3600)
 
2179
    >>> rfc3339_duration_to_delta("PT24H")
 
2180
    datetime.timedelta(1)
 
2181
    >>> rfc3339_duration_to_delta("P1W")
 
2182
    datetime.timedelta(7)
 
2183
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2184
    datetime.timedelta(0, 330)
 
2185
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2186
    datetime.timedelta(1, 200)
2782
2187
    """
2783
 
 
 
2188
    
2784
2189
    # Parsing an RFC 3339 duration with regular expressions is not
2785
2190
    # possible - there would have to be multiple places for the same
2786
2191
    # values, like seconds.  The current code, while more esoteric, is
2787
2192
    # cleaner without depending on a parsing library.  If Python had a
2788
2193
    # built-in library for parsing we would use it, but we'd like to
2789
2194
    # avoid excessive use of external libraries.
2790
 
 
 
2195
    
2791
2196
    # New type for defining tokens, syntax, and semantics all-in-one
2792
2197
    Token = collections.namedtuple("Token", (
2793
2198
        "regexp",  # To match token; if "value" is not None, must have
2826
2231
                           frozenset((token_year, token_month,
2827
2232
                                      token_day, token_time,
2828
2233
                                      token_week)))
2829
 
    # Define starting values:
2830
 
    # Value so far
2831
 
    value = datetime.timedelta()
 
2234
    # Define starting values
 
2235
    value = datetime.timedelta() # Value so far
2832
2236
    found_token = None
2833
 
    # Following valid tokens
2834
 
    followers = frozenset((token_duration, ))
2835
 
    # String left to parse
2836
 
    s = duration
 
2237
    followers = frozenset((token_duration, )) # Following valid tokens
 
2238
    s = duration                # String left to parse
2837
2239
    # Loop until end token is found
2838
2240
    while found_token is not token_end:
2839
2241
        # Search for any currently valid tokens
2863
2265
 
2864
2266
def string_to_delta(interval):
2865
2267
    """Parse a string and return a datetime.timedelta
2866
 
 
2867
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2868
 
    True
2869
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2870
 
    True
2871
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2872
 
    True
2873
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2874
 
    True
2875
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2876
 
    True
2877
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2878
 
    True
 
2268
    
 
2269
    >>> string_to_delta('7d')
 
2270
    datetime.timedelta(7)
 
2271
    >>> string_to_delta('60s')
 
2272
    datetime.timedelta(0, 60)
 
2273
    >>> string_to_delta('60m')
 
2274
    datetime.timedelta(0, 3600)
 
2275
    >>> string_to_delta('24h')
 
2276
    datetime.timedelta(1)
 
2277
    >>> string_to_delta('1w')
 
2278
    datetime.timedelta(7)
 
2279
    >>> string_to_delta('5m 30s')
 
2280
    datetime.timedelta(0, 330)
2879
2281
    """
2880
 
 
 
2282
    
2881
2283
    try:
2882
2284
        return rfc3339_duration_to_delta(interval)
2883
2285
    except ValueError:
2884
2286
        pass
2885
 
 
 
2287
    
2886
2288
    timevalue = datetime.timedelta(0)
2887
2289
    for s in interval.split():
2888
2290
        try:
2906
2308
    return timevalue
2907
2309
 
2908
2310
 
2909
 
def daemon(nochdir=False, noclose=False):
 
2311
def daemon(nochdir = False, noclose = False):
2910
2312
    """See daemon(3).  Standard BSD Unix function.
2911
 
 
 
2313
    
2912
2314
    This should really exist as os.daemon, but it doesn't (yet)."""
2913
2315
    if os.fork():
2914
2316
        sys.exit()
2932
2334
 
2933
2335
 
2934
2336
def main():
2935
 
 
 
2337
    
2936
2338
    ##################################################################
2937
2339
    # Parsing of options, both command line and config file
2938
 
 
 
2340
    
2939
2341
    parser = argparse.ArgumentParser()
2940
2342
    parser.add_argument("-v", "--version", action="version",
2941
 
                        version="%(prog)s {}".format(version),
 
2343
                        version = "%(prog)s {}".format(version),
2942
2344
                        help="show version number and exit")
2943
2345
    parser.add_argument("-i", "--interface", metavar="IF",
2944
2346
                        help="Bind to interface IF")
2980
2382
    parser.add_argument("--no-zeroconf", action="store_false",
2981
2383
                        dest="zeroconf", help="Do not use Zeroconf",
2982
2384
                        default=None)
2983
 
 
 
2385
    
2984
2386
    options = parser.parse_args()
2985
 
 
 
2387
    
 
2388
    if options.check:
 
2389
        import doctest
 
2390
        fail_count, test_count = doctest.testmod()
 
2391
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2392
    
2986
2393
    # 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
 
 
 
2394
    server_defaults = { "interface": "",
 
2395
                        "address": "",
 
2396
                        "port": "",
 
2397
                        "debug": "False",
 
2398
                        "priority":
 
2399
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2400
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2401
                        "servicename": "Mandos",
 
2402
                        "use_dbus": "True",
 
2403
                        "use_ipv6": "True",
 
2404
                        "debuglevel": "",
 
2405
                        "restore": "True",
 
2406
                        "socket": "",
 
2407
                        "statedir": "/var/lib/mandos",
 
2408
                        "foreground": "False",
 
2409
                        "zeroconf": "True",
 
2410
                    }
 
2411
    
3010
2412
    # Parse config file for server-global settings
3011
 
    server_config = configparser.ConfigParser(server_defaults)
 
2413
    server_config = configparser.SafeConfigParser(server_defaults)
3012
2414
    del server_defaults
3013
2415
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3014
 
    # Convert the ConfigParser object to a dict
 
2416
    # Convert the SafeConfigParser object to a dict
3015
2417
    server_settings = server_config.defaults()
3016
2418
    # Use the appropriate methods on the non-string config options
3017
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3018
 
                   "foreground", "zeroconf"):
 
2419
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3019
2420
        server_settings[option] = server_config.getboolean("DEFAULT",
3020
2421
                                                           option)
3021
2422
    if server_settings["port"]:
3031
2432
            server_settings["socket"] = os.dup(server_settings
3032
2433
                                               ["socket"])
3033
2434
    del server_config
3034
 
 
 
2435
    
3035
2436
    # Override the settings from the config file with command line
3036
2437
    # options, if set.
3037
2438
    for option in ("interface", "address", "port", "debug",
3055
2456
    if server_settings["debug"]:
3056
2457
        server_settings["foreground"] = True
3057
2458
    # Now we have our good server settings in "server_settings"
3058
 
 
 
2459
    
3059
2460
    ##################################################################
3060
 
 
 
2461
    
3061
2462
    if (not server_settings["zeroconf"]
3062
2463
        and not (server_settings["port"]
3063
2464
                 or server_settings["socket"] != "")):
3064
2465
        parser.error("Needs port or socket to work without Zeroconf")
3065
 
 
 
2466
    
3066
2467
    # For convenience
3067
2468
    debug = server_settings["debug"]
3068
2469
    debuglevel = server_settings["debuglevel"]
3072
2473
                                     stored_state_file)
3073
2474
    foreground = server_settings["foreground"]
3074
2475
    zeroconf = server_settings["zeroconf"]
3075
 
 
 
2476
    
3076
2477
    if debug:
3077
2478
        initlogger(debug, logging.DEBUG)
3078
2479
    else:
3081
2482
        else:
3082
2483
            level = getattr(logging, debuglevel.upper())
3083
2484
            initlogger(debug, level)
3084
 
 
 
2485
    
3085
2486
    if server_settings["servicename"] != "Mandos":
3086
2487
        syslogger.setFormatter(
3087
2488
            logging.Formatter('Mandos ({}) [%(process)d]:'
3088
2489
                              ' %(levelname)s: %(message)s'.format(
3089
2490
                                  server_settings["servicename"])))
3090
 
 
 
2491
    
3091
2492
    # Parse config file with clients
3092
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
2493
    client_config = configparser.SafeConfigParser(Client
 
2494
                                                  .client_defaults)
3093
2495
    client_config.read(os.path.join(server_settings["configdir"],
3094
2496
                                    "clients.conf"))
3095
 
 
 
2497
    
3096
2498
    global mandos_dbus_service
3097
2499
    mandos_dbus_service = None
3098
 
 
 
2500
    
3099
2501
    socketfd = None
3100
2502
    if server_settings["socket"] != "":
3101
2503
        socketfd = server_settings["socket"]
3117
2519
        except IOError as e:
3118
2520
            logger.error("Could not open file %r", pidfilename,
3119
2521
                         exc_info=e)
3120
 
 
3121
 
    for name, group in (("_mandos", "_mandos"),
3122
 
                        ("mandos", "mandos"),
3123
 
                        ("nobody", "nogroup")):
 
2522
    
 
2523
    for name in ("_mandos", "mandos", "nobody"):
3124
2524
        try:
3125
2525
            uid = pwd.getpwnam(name).pw_uid
3126
 
            gid = pwd.getpwnam(group).pw_gid
 
2526
            gid = pwd.getpwnam(name).pw_gid
3127
2527
            break
3128
2528
        except KeyError:
3129
2529
            continue
3133
2533
    try:
3134
2534
        os.setgid(gid)
3135
2535
        os.setuid(uid)
3136
 
        if debug:
3137
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3138
 
                                                             gid))
3139
2536
    except OSError as error:
3140
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3141
 
                       .format(uid, gid, os.strerror(error.errno)))
3142
2537
        if error.errno != errno.EPERM:
3143
2538
            raise
3144
 
 
 
2539
    
3145
2540
    if debug:
3146
2541
        # Enable all possible GnuTLS debugging
3147
 
 
 
2542
        
3148
2543
        # "Use a log level over 10 to enable all debugging options."
3149
2544
        # - GnuTLS manual
3150
 
        gnutls.global_set_log_level(11)
3151
 
 
3152
 
        @gnutls.log_func
 
2545
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2546
        
 
2547
        @gnutls.library.types.gnutls_log_func
3153
2548
        def debug_gnutls(level, string):
3154
2549
            logger.debug("GnuTLS: %s", string[:-1])
3155
 
 
3156
 
        gnutls.global_set_log_function(debug_gnutls)
3157
 
 
 
2550
        
 
2551
        gnutls.library.functions.gnutls_global_set_log_function(
 
2552
            debug_gnutls)
 
2553
        
3158
2554
        # Redirect stdin so all checkers get /dev/null
3159
2555
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3160
2556
        os.dup2(null, sys.stdin.fileno())
3161
2557
        if null > 2:
3162
2558
            os.close(null)
3163
 
 
 
2559
    
3164
2560
    # Need to fork before connecting to D-Bus
3165
2561
    if not foreground:
3166
2562
        # Close all input and output, do double fork, etc.
3167
2563
        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
 
 
 
2564
    
 
2565
    # multiprocessing will use threads, so before we use gobject we
 
2566
    # need to inform gobject that threads will be used.
 
2567
    gobject.threads_init()
 
2568
    
3174
2569
    global main_loop
3175
2570
    # From the Avahi example code
3176
2571
    DBusGMainLoop(set_as_default=True)
3177
 
    main_loop = GLib.MainLoop()
 
2572
    main_loop = gobject.MainLoop()
3178
2573
    bus = dbus.SystemBus()
3179
2574
    # End of Avahi example code
3180
2575
    if use_dbus:
3193
2588
    if zeroconf:
3194
2589
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3195
2590
        service = AvahiServiceToSyslog(
3196
 
            name=server_settings["servicename"],
3197
 
            servicetype="_mandos._tcp",
3198
 
            protocol=protocol,
3199
 
            bus=bus)
 
2591
            name = server_settings["servicename"],
 
2592
            servicetype = "_mandos._tcp",
 
2593
            protocol = protocol,
 
2594
            bus = bus)
3200
2595
        if server_settings["interface"]:
3201
2596
            service.interface = if_nametoindex(
3202
2597
                server_settings["interface"].encode("utf-8"))
3203
 
 
 
2598
    
3204
2599
    global multiprocessing_manager
3205
2600
    multiprocessing_manager = multiprocessing.Manager()
3206
 
 
 
2601
    
3207
2602
    client_class = Client
3208
2603
    if use_dbus:
3209
 
        client_class = functools.partial(ClientDBus, bus=bus)
3210
 
 
 
2604
        client_class = functools.partial(ClientDBus, bus = bus)
 
2605
    
3211
2606
    client_settings = Client.config_parser(client_config)
3212
2607
    old_client_settings = {}
3213
2608
    clients_data = {}
3214
 
 
 
2609
    
3215
2610
    # This is used to redirect stdout and stderr for checker processes
3216
2611
    global wnull
3217
 
    wnull = open(os.devnull, "w")  # A writable /dev/null
 
2612
    wnull = open(os.devnull, "w") # A writable /dev/null
3218
2613
    # Only used if server is running in foreground but not in debug
3219
2614
    # mode
3220
2615
    if debug or not foreground:
3221
2616
        wnull.close()
3222
 
 
 
2617
    
3223
2618
    # Get client data and settings from last running state.
3224
2619
    if server_settings["restore"]:
3225
2620
        try:
3226
2621
            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"))
 
2622
                clients_data, old_client_settings = pickle.load(
 
2623
                    stored_state)
3276
2624
            os.remove(stored_state_path)
3277
2625
        except IOError as e:
3278
2626
            if e.errno == errno.ENOENT:
3286
2634
            logger.warning("Could not load persistent state: "
3287
2635
                           "EOFError:",
3288
2636
                           exc_info=e)
3289
 
 
 
2637
    
3290
2638
    with PGPEngine() as pgp:
3291
2639
        for client_name, client in clients_data.items():
3292
2640
            # Skip removed clients
3293
2641
            if client_name not in client_settings:
3294
2642
                continue
3295
 
 
 
2643
            
3296
2644
            # Decide which value to use after restoring saved state.
3297
2645
            # We have three different values: Old config file,
3298
2646
            # new config file, and saved state.
3309
2657
                        client[name] = value
3310
2658
                except KeyError:
3311
2659
                    pass
3312
 
 
 
2660
            
3313
2661
            # Clients who has passed its expire date can still be
3314
2662
            # enabled if its last checker was successful.  A Client
3315
2663
            # whose checker succeeded before we stored its state is
3348
2696
                    client_name))
3349
2697
                client["secret"] = (client_settings[client_name]
3350
2698
                                    ["secret"])
3351
 
 
 
2699
    
3352
2700
    # Add/remove clients based on new changes made to config
3353
2701
    for client_name in (set(old_client_settings)
3354
2702
                        - set(client_settings)):
3356
2704
    for client_name in (set(client_settings)
3357
2705
                        - set(old_client_settings)):
3358
2706
        clients_data[client_name] = client_settings[client_name]
3359
 
 
 
2707
    
3360
2708
    # Create all client objects
3361
2709
    for client_name, client in clients_data.items():
3362
2710
        tcp_server.clients[client_name] = client_class(
3363
 
            name=client_name,
3364
 
            settings=client,
3365
 
            server_settings=server_settings)
3366
 
 
 
2711
            name = client_name,
 
2712
            settings = client,
 
2713
            server_settings = server_settings)
 
2714
    
3367
2715
    if not tcp_server.clients:
3368
2716
        logger.warning("No clients defined")
3369
 
 
 
2717
    
3370
2718
    if not foreground:
3371
2719
        if pidfile is not None:
3372
2720
            pid = os.getpid()
3378
2726
                             pidfilename, pid)
3379
2727
        del pidfile
3380
2728
        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
 
 
 
2729
    
 
2730
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
2731
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
2732
    
3386
2733
    if use_dbus:
3387
 
 
 
2734
        
3388
2735
        @alternate_dbus_interfaces(
3389
 
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3390
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
2736
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2737
        class MandosDBusService(DBusObjectWithProperties):
3391
2738
            """A D-Bus proxy object"""
3392
 
 
 
2739
            
3393
2740
            def __init__(self):
3394
2741
                dbus.service.Object.__init__(self, bus, "/")
3395
 
 
 
2742
            
3396
2743
            _interface = "se.recompile.Mandos"
3397
 
 
 
2744
            
 
2745
            @dbus_interface_annotations(_interface)
 
2746
            def _foo(self):
 
2747
                return {
 
2748
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2749
                    "false" }
 
2750
            
3398
2751
            @dbus.service.signal(_interface, signature="o")
3399
2752
            def ClientAdded(self, objpath):
3400
2753
                "D-Bus signal"
3401
2754
                pass
3402
 
 
 
2755
            
3403
2756
            @dbus.service.signal(_interface, signature="ss")
3404
 
            def ClientNotFound(self, key_id, address):
 
2757
            def ClientNotFound(self, fingerprint, address):
3405
2758
                "D-Bus signal"
3406
2759
                pass
3407
 
 
3408
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3409
 
                               "true"})
 
2760
            
3410
2761
            @dbus.service.signal(_interface, signature="os")
3411
2762
            def ClientRemoved(self, objpath, name):
3412
2763
                "D-Bus signal"
3413
2764
                pass
3414
 
 
3415
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3416
 
                               "true"})
 
2765
            
3417
2766
            @dbus.service.method(_interface, out_signature="ao")
3418
2767
            def GetAllClients(self):
3419
2768
                "D-Bus method"
3420
2769
                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"})
 
2770
                                  tcp_server.clients.itervalues())
 
2771
            
3425
2772
            @dbus.service.method(_interface,
3426
2773
                                 out_signature="a{oa{sv}}")
3427
2774
            def GetAllClientsWithProperties(self):
3428
2775
                "D-Bus method"
3429
2776
                return dbus.Dictionary(
3430
 
                    {c.dbus_object_path: c.GetAll(
3431
 
                        "se.recompile.Mandos.Client")
3432
 
                     for c in tcp_server.clients.values()},
 
2777
                    { c.dbus_object_path: c.GetAll("")
 
2778
                      for c in tcp_server.clients.itervalues() },
3433
2779
                    signature="oa{sv}")
3434
 
 
 
2780
            
3435
2781
            @dbus.service.method(_interface, in_signature="o")
3436
2782
            def RemoveClient(self, object_path):
3437
2783
                "D-Bus method"
3438
 
                for c in tcp_server.clients.values():
 
2784
                for c in tcp_server.clients.itervalues():
3439
2785
                    if c.dbus_object_path == object_path:
3440
2786
                        del tcp_server.clients[c.name]
3441
2787
                        c.remove_from_connection()
3442
 
                        # Don't signal the disabling
 
2788
                        # Don't signal anything except ClientRemoved
3443
2789
                        c.disable(quiet=True)
3444
 
                        # Emit D-Bus signal for removal
3445
 
                        self.client_removed_signal(c)
 
2790
                        # Emit D-Bus signal
 
2791
                        self.ClientRemoved(object_path, c.name)
3446
2792
                        return
3447
2793
                raise KeyError(object_path)
3448
 
 
 
2794
            
3449
2795
            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
 
 
 
2796
        
3487
2797
        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
 
 
 
2798
    
3494
2799
    def cleanup():
3495
2800
        "Cleanup function; run on exit"
3496
2801
        if zeroconf:
3497
2802
            service.cleanup()
3498
 
 
3499
 
        mp.active_children()
3500
 
        wn.close()
 
2803
        
 
2804
        multiprocessing.active_children()
 
2805
        wnull.close()
3501
2806
        if not (tcp_server.clients or client_settings):
3502
2807
            return
3503
 
 
 
2808
        
3504
2809
        # Store client before exiting. Secrets are encrypted with key
3505
2810
        # based on what config file has. If config file is
3506
2811
        # removed/edited, old secret will thus be unrecovable.
3507
2812
        clients = {}
3508
2813
        with PGPEngine() as pgp:
3509
 
            for client in tcp_server.clients.values():
 
2814
            for client in tcp_server.clients.itervalues():
3510
2815
                key = client_settings[client.name]["secret"]
3511
2816
                client.encrypted_secret = pgp.encrypt(client.secret,
3512
2817
                                                      key)
3513
2818
                client_dict = {}
3514
 
 
 
2819
                
3515
2820
                # A list of attributes that can not be pickled
3516
2821
                # + secret.
3517
 
                exclude = {"bus", "changedstate", "secret",
3518
 
                           "checker", "server_settings"}
 
2822
                exclude = { "bus", "changedstate", "secret",
 
2823
                            "checker", "server_settings" }
3519
2824
                for name, typ in inspect.getmembers(dbus.service
3520
2825
                                                    .Object):
3521
2826
                    exclude.add(name)
3522
 
 
 
2827
                
3523
2828
                client_dict["encrypted_secret"] = (client
3524
2829
                                                   .encrypted_secret)
3525
2830
                for attr in client.client_structure:
3526
2831
                    if attr not in exclude:
3527
2832
                        client_dict[attr] = getattr(client, attr)
3528
 
 
 
2833
                
3529
2834
                clients[client.name] = client_dict
3530
2835
                del client_settings[client.name]["secret"]
3531
 
 
 
2836
        
3532
2837
        try:
3533
2838
            with tempfile.NamedTemporaryFile(
3534
2839
                    mode='wb',
3536
2841
                    prefix='clients-',
3537
2842
                    dir=os.path.dirname(stored_state_path),
3538
2843
                    delete=False) as stored_state:
3539
 
                pickle.dump((clients, client_settings), stored_state,
3540
 
                            protocol=2)
 
2844
                pickle.dump((clients, client_settings), stored_state)
3541
2845
                tempname = stored_state.name
3542
2846
            os.rename(tempname, stored_state_path)
3543
2847
        except (IOError, OSError) as e:
3553
2857
                logger.warning("Could not save persistent state:",
3554
2858
                               exc_info=e)
3555
2859
                raise
3556
 
 
 
2860
        
3557
2861
        # Delete all clients, and settings from config
3558
2862
        while tcp_server.clients:
3559
2863
            name, client = tcp_server.clients.popitem()
3560
2864
            if use_dbus:
3561
2865
                client.remove_from_connection()
3562
 
            # Don't signal the disabling
 
2866
            # Don't signal anything except ClientRemoved
3563
2867
            client.disable(quiet=True)
3564
 
            # Emit D-Bus signal for removal
3565
2868
            if use_dbus:
3566
 
                mandos_dbus_service.client_removed_signal(client)
 
2869
                # Emit D-Bus signal
 
2870
                mandos_dbus_service.ClientRemoved(
 
2871
                    client.dbus_object_path, client.name)
3567
2872
        client_settings.clear()
3568
 
 
 
2873
    
3569
2874
    atexit.register(cleanup)
3570
 
 
3571
 
    for client in tcp_server.clients.values():
 
2875
    
 
2876
    for client in tcp_server.clients.itervalues():
3572
2877
        if use_dbus:
3573
 
            # Emit D-Bus signal for adding
3574
 
            mandos_dbus_service.client_added_signal(client)
 
2878
            # Emit D-Bus signal
 
2879
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
3575
2880
        # Need to initiate checking of clients
3576
2881
        if client.enabled:
3577
2882
            client.init_checker()
3578
 
 
 
2883
    
3579
2884
    tcp_server.enable()
3580
2885
    tcp_server.server_activate()
3581
 
 
 
2886
    
3582
2887
    # Find out what port we got
3583
2888
    if zeroconf:
3584
2889
        service.port = tcp_server.socket.getsockname()[1]
3589
2894
    else:                       # IPv4
3590
2895
        logger.info("Now listening on address %r, port %d",
3591
2896
                    *tcp_server.socket.getsockname())
3592
 
 
3593
 
    # service.interface = tcp_server.socket.getsockname()[3]
3594
 
 
 
2897
    
 
2898
    #service.interface = tcp_server.socket.getsockname()[3]
 
2899
    
3595
2900
    try:
3596
2901
        if zeroconf:
3597
2902
            # From the Avahi example code
3602
2907
                cleanup()
3603
2908
                sys.exit(1)
3604
2909
            # 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
 
 
 
2910
        
 
2911
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
2912
                             lambda *args, **kwargs:
 
2913
                             (tcp_server.handle_request
 
2914
                              (*args[2:], **kwargs) or True))
 
2915
        
3612
2916
        logger.debug("Starting main loop")
3613
2917
        main_loop.run()
3614
2918
    except AvahiError as error:
3623
2927
    # Must run before the D-Bus bus name gets deregistered
3624
2928
    cleanup()
3625
2929
 
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
2930
 
3643
2931
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()
 
2932
    main()