/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-02-28 03:01:43 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160228030143-i6w90r7wzkvlx9kq
Stop using python-gnutls.  Use GnuTLS 3.3 or later directly.

* INSTALL: Document dependency on GnuTLS 3.3 and remove dependency on
          Python-GnuTLS.

* debian/control (Source: mandos/Build-Depends): Add (>= 3.3.0) to
                                                 "libgnutls28-dev" and
                                                 "gnutls-dev".
  (Source: mandos/Build-Depends-Indep): Remove "python2.7-gnutls".
  (Package: mandos/Depends): Remove "python-gnutls" and
                             "python2.7-gnutls", add "libgnutls28-dev
                             (>= 3.3.0) | libgnutls30 (>= 3.3.0)"
* mandos: Remove imports of "gnutls" and all submodules.
  (GnuTLS, gnutls): New; simulate a "gnutls" module.  Change all
                    callers to match new shorter names.

Show diffs side-by-side

added added

removed removed

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