/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: 2019-08-18 00:23:21 UTC
  • mto: This revision was merged to the branch mainline in revision 390.
  • Revision ID: teddy@recompile.se-20190818002321-qvjsogu0rhoyuwyc
Use the systemd sysusers.d mechanism, if present

* Makefile (SYSUSERS): New.
  (install-server): Also install sysusers.d file, if $(SYSUSERS)
                    exists.
* debian/mandos.dirs (usr/lib/sysusers.d): New.
* sysusers.d-mandos.conf: New.

Show diffs side-by-side

added added

removed removed

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