/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-05 21:42:56 UTC
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

Show diffs side-by-side

added added

removed removed

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