/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-07-27 10:11:45 UTC
  • Revision ID: teddy@recompile.se-20190727101145-jnpbpf8220gldbcd
Add dracut(8) support

Add support for the dracut(8) system for generating initramfs image
files; dracut is an alternative to the "initramfs-tools" package.

* .bzrignore (dracut-module/password-agent): Ignore new binary file.
* dracut-module: New directory for the dracut module.
* INSTALL (Prerequisites/Libraries/Mandos Client): Add dracut as an
                                                   alternative to
                                                   initramfs-tools,
                                                   and also add GLib.
* Makefile (DRACUTMODULE, GLIB_CFLAGS, GLIB_LIBS): New.
  (CPROGS): Add "dracut-module/password-agent".
  (DOCS): Add "dracut-module/password-agent.8mandos".
  (dracut-module/password-agent.8mandos): New.
  (dracut-module/password-agent.8mandos.xhtml): - '' -
  (dracut-module/password-agent): - '' -
  (check): Add command to run tests of password-agent(8mandos).
  (install-client-nokey): Also install the dracut module directory,
                          its files, and the password-agent(8mandos)
                          manual page.
  (install-client): To update the initramfs image file, run
                    update-initramfs or dracut depending on what is
                    installed.
  (uninstall-client): - '' - and also uninstall the the files in the
                      dracut module directory, that directory itself,
                      and the password-agent(8mandos) manual page.
* debian/control (Build-Depends): Add "libglib2.0-dev (>=2.40)".
  (Package: mandos-client/Depends): Add "dracut (>= 044+241-3)" as an
                                    alternative dependency to
                                    initramfs-tools.
  (Package: mandos-client/Conflicts): New; set to
                                      "dracut-config-generic".
  (debian/mandos-client.README.Debian): Document alternative commands
                                        to update the initramfs image
                                        for when dracut is used.
* debian/mandos-client.postinst (update_initramfs): Use alternative
                                                    commands to update
                                                    the initramfs
                                                    image for when
                                                    dracut is used.
* debian/tests/control (password-agent, password-agent-suid): Add two
                                                              new tests.
* dracut-module/ask-password-mandos.path: New.
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/cmdline-mandos.sh: - '' -
* dracut-module/module-setup.sh: - '' -
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: - '' -
* initramfs-unpack: Use the dracut "skipcpio" command, if available.
                    Also be more flexible and try hard to detect where
                    compressed data starts.
* plugins.d/mandos-client.xml (SECURITY): Be more precise that the
                                          mandos-client binary might
                                          not always be setuid, but
                                          that the program assumes
                                          that it has been started
                                          that way.
* plugins.d/password-prompt.c: Add new "--prompt" option.
  (conflict_detection): First try to detect the new PID file of
                        plymouth.
  (main): Define and use new "prompt" variable.
* plugins.d/password-prompt.xml (SYNOPSIS): Show new --prompt option.
  (DESCRIPTION): Describe new behavior of looking for plymouth PID
                 file.
  (OPTIONS): Document new "--prompt" option.
  (ENVIRONMENT): Clarify that the CRYPTTAB_SOURCE and CRYPTTAB_NAME
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the CRYPTTAB_SOURCE and
                 CRYPTTAB_NAME comes from, since this can now be
                 either initramfs-tools or dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference, and add commas
              to separate the other references.
* plugins.d/plymouth.c: Add new "--prompt" and "--debug" options.
  (debug): New global flag.
  (fprintf_plus): New function, used for debug output.
  (exec_and_wait): Add extra "const" to "argv" argument.
  (main): Define and use new "prompt" variable.  Add debug output.
  (main/options, main/parse_opt): New; used to parse options.
* plugins.d/plymouth.xml (SYNOPSIS): Show new options.
  (OPTIONS): Document new options.
  (ENVIRONMENT): Clarify that the cryptsource and crypttarget
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the cryptsource and crypttarget
                 comes from, since this can now be either
                 initramfs-tools or dracut.
  (EXAMPLE): Add an example using an option.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/splashy.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/usplash.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.

Show diffs side-by-side

added added

removed removed

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