/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-06-28 16:35:27 UTC
  • mto: (237.7.307 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

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