/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-03-03 16:25:45 UTC
  • Revision ID: teddy@recompile.se-20190303162545-vjdm7icnhpprzuwb
mandos-ctl: Refactor; move TableOfClients into PrintTableCmd

* mandos-ctl (TableOfClients): Moved into PrintTableCmd; user changed.
  (PrintTableCmd.TableOfClients): New.

Show diffs side-by-side

added added

removed removed

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