/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: 2015-08-10 09:00:23 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810090023-fz6vjqr7zf33e2tf
Support the standard org.freedesktop.DBus.ObjectManager interface.

Now that the D-Bus standard has an interface to keep track of new and
removed objects, use that instead of our own methods.  This deprecates
our D-Bus methods "GetAllClients" and "GetAllClientsWithProperties"
and the signals "ClientAdded" and "ClientRemoved", all on the server
interface "se.recompile.Mandos".

* DBUS-API: Removed references to deprecated methods and signals;
  insert reference to the org.freedesktop.DBus.ObjectManager
  interface.
* mandos (DBusObjectWithProperties._get_all_interface_names): New.
  (dbus.OBJECT_MANAGER_IFACE): If not present, monkey patch.
  (DBusObjectWithObjectManager): New.
  (main/MandosDBusService): Inherit from DBusObjectWithObjectManager.
  (main/MandosDBusService.ClientRemoved): Annotate as deprecated.
  (main/MandosDBusService.GetAllClients): - '' -
  (main/MandosDBusService.GetAllClientsWithProperties): Annotate as
                                                        deprecated.
                                                        Also only
                                                        return
                                                        properties on
                                                        client
                                                        interface.
  (main/MandosDBusService.RemoveClient): Call client_removed_signal
                                         instead of ClientRemoved.
  (main/MandosDBusService.GetManagedObjects): New.
  (main/MandosDBusService.client_added_signal): New.
  (main/MandosDBusService.client_removed_signal): - '' -
  (main/cleanup): Call "client_removed_signal" instead of sending
                  "ClientRemoved" signal directly.
  (main): Call "client_added_signal" instead of sending "ClientAdded"
          signal directly.
* mandos-ctl: Use GetManagedObjects instead of
              GetAllClientsWithProperties.  Also, show better error
              message in case of failure to connect to the D-Bus

* mandos-monitor (MandosClientPropertyCache.properties_changed):
  Bug fix; only update properties on client interface.
  (UserInterface.find_and_remove_client): Change to accept arguments
                                          from InterfacesRemoved
                                          signal.  Also, bug fix:
                                          working error message when
                                          removing unknown client.
  (UserInterface.add_new_client): Change to accept arguments from
                                  InterfacesRemoved signal.  Pass
                                  properties to MandosClientWidget
                                  constructor.
  (UserInterface.run): Connect find_and_remove_client method to
                       InterfacesRemoved signal and the add_new_client
                       method to the InterfacesAdded signal.

Show diffs side-by-side

added added

removed removed

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