/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2019-12-05 03:38:07 UTC
  • Revision ID: teddy@recompile.se-20191205033807-6awt45zpgp194vl1
From: Frans Spiesschaert <Frans.Spiesschaert@yucom.be>

Add Dutch debconf translation

* debian/po/nl.po: New.

Acked-by: Teddy Hogeborn <teddy@recompile.se>

Show diffs side-by-side

added added

removed removed

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