/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 10:59:18 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160228105918-tb8pt2p5j0tkcls3
Handle GnuTLS errors and partial sends in gnutls "module".

* mandos (GnuTLS.E_INTERRUPTED, GnuTLS.E_AGAIN): New.
  (GnuTLS.Error): Set error code as "code" attribute.
  (GnuTLS.ClientSession.send): Handle partial sends with a loop.
  (GnuTLS._retry_on_error): New function.
  (GnuTLS.record_send, GnuTLS.handshake, GnuTLS.bye): Set "errcheck"
                                                      attribute to
                                                    "_retry_on_error".
  (ClientHandler.handle): Remove loop for handling partial sends;
                          GnuTLS.ClientSession.send() will do that.

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