/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
3 by Björn Påhlsson
Python based server
1
#!/usr/bin/python
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
2
# -*- mode: python; coding: utf-8 -*-
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
3
# 
4
# Mandos server - give out binary blobs to connecting clients.
5
# 
6
# This program is partly derived from an example program for an Avahi
7
# service publisher, downloaded from
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
237.2.99 by Teddy Hogeborn
Code cleanup.
9
# methods "add", "remove", "server_state_changed",
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
# "AvahiService" class, and some lines in "main".
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
12
# 
28 by Teddy Hogeborn
* server.conf: New file.
13
# Everything else is
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
14
# Copyright © 2008-2010 Teddy Hogeborn
15
# Copyright © 2008-2010 Björn Påhlsson
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
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
19
# the Free Software Foundation, either version 3 of the License, or
20
# (at your option) any later version.
21
#
22
#     This program is distributed in the hope that it will be useful,
23
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
24
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
#     GNU General Public License for more details.
26
# 
27
# You should have received a copy of the GNU General Public License
109 by Teddy Hogeborn
* .bzrignore: New.
28
# along with this program.  If not, see
29
# <http://www.gnu.org/licenses/>.
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
30
# 
28 by Teddy Hogeborn
* server.conf: New file.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
32
# 
3 by Björn Påhlsson
Python based server
33
237 by Teddy Hogeborn
* mandos: Also import "with_statement" and "absolute_import" from
34
from __future__ import division, with_statement, absolute_import
10 by Teddy Hogeborn
* server.py: Bug fix: Do "from __future__ import division".
35
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
36
import SocketServer as socketserver
3 by Björn Påhlsson
Python based server
37
import socket
238 by Teddy Hogeborn
Merge from trunk, but disable the unfinished D-Bus feature:
38
import optparse
3 by Björn Påhlsson
Python based server
39
import datetime
40
import errno
41
import gnutls.crypto
42
import gnutls.connection
43
import gnutls.errors
12 by Teddy Hogeborn
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
44
import gnutls.library.functions
45
import gnutls.library.constants
46
import gnutls.library.types
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
47
import ConfigParser as configparser
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
48
import sys
9 by Teddy Hogeborn
* client.cpp (main): Get t_old early since it is used on error exits.
49
import re
50
import os
51
import signal
10 by Teddy Hogeborn
* server.py: Bug fix: Do "from __future__ import division".
52
import subprocess
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
53
import atexit
54
import stat
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
55
import logging
56
import logging.handlers
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
57
import pwd
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
58
import contextlib
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
59
import struct
60
import fcntl
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
61
import functools
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
62
import cPickle as pickle
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
63
import multiprocessing
5 by Teddy Hogeborn
* server.py (server_metaclass): New.
64
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
65
import dbus
237.1.1 by Teddy Hogeborn
First steps of a D-Bus interface to the server.
66
import dbus.service
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
67
import gobject
68
import avahi
69
from dbus.mainloop.glib import DBusGMainLoop
12 by Teddy Hogeborn
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
70
import ctypes
215 by Teddy Hogeborn
* mandos: Remove unused "select" module. Import "ctypes.util".
71
import ctypes.util
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
72
import xml.dom.minidom
73
import inspect
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
74
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
75
try:
76
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
77
except AttributeError:
78
    try:
79
        from IN import SO_BINDTODEVICE
80
    except ImportError:
237.2.101 by Teddy Hogeborn
* mandos: Minor doc string fixes.
81
        SO_BINDTODEVICE = None
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
82
83
273 by Björn Påhlsson
* Makefile (version): Changed to "1.2.1".
84
version = "1.2.1"
13 by Björn Påhlsson
Added following support:
85
24.1.154 by Björn Påhlsson
merge
86
#logger = logging.getLogger(u'mandos')
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
87
logger = logging.Logger(u'mandos')
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
88
syslogger = (logging.handlers.SysLogHandler
89
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
              address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
92
                       (u'Mandos [%(process)d]: %(levelname)s:'
93
                        u' %(message)s'))
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
94
logger.addHandler(syslogger)
13 by Björn Påhlsson
Added following support:
95
61 by Teddy Hogeborn
* mandos (console): Define handler globally.
96
console = logging.StreamHandler()
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
                                       u' %(levelname)s:'
99
                                       u' %(message)s'))
61 by Teddy Hogeborn
* mandos (console): Define handler globally.
100
logger.addHandler(console)
28 by Teddy Hogeborn
* server.conf: New file.
101
102
class AvahiError(Exception):
237.2.5 by Teddy Hogeborn
* mandos (AvahiError): Converted to use unicode. All users changed.
103
    def __init__(self, value, *args, **kwargs):
28 by Teddy Hogeborn
* server.conf: New file.
104
        self.value = value
237.2.5 by Teddy Hogeborn
* mandos (AvahiError): Converted to use unicode. All users changed.
105
        super(AvahiError, self).__init__(value, *args, **kwargs)
106
    def __unicode__(self):
107
        return unicode(repr(self.value))
28 by Teddy Hogeborn
* server.conf: New file.
108
109
class AvahiServiceError(AvahiError):
110
    pass
111
112
class AvahiGroupError(AvahiError):
113
    pass
114
115
116
class AvahiService(object):
45 by Teddy Hogeborn
* server.py: Cosmetic changes.
117
    """An Avahi (Zeroconf) service.
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
118
    
45 by Teddy Hogeborn
* server.py: Cosmetic changes.
119
    Attributes:
28 by Teddy Hogeborn
* server.conf: New file.
120
    interface: integer; avahi.IF_UNSPEC or an interface index.
121
               Used to optionally bind to the specified interface.
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
122
    name: string; Example: u'Mandos'
123
    type: string; Example: u'_mandos._tcp'.
45 by Teddy Hogeborn
* server.py: Cosmetic changes.
124
                  See <http://www.dns-sd.org/ServiceTypes.html>
125
    port: integer; what port to announce
126
    TXT: list of strings; TXT record for the service
127
    domain: string; Domain to publish on, default to .local if empty.
128
    host: string; Host to publish records for, default is localhost
129
    max_renames: integer; maximum number of renames
130
    rename_count: integer; counter so we only rename after collisions
131
                  a sensible number of times
237.2.99 by Teddy Hogeborn
Code cleanup.
132
    group: D-Bus Entry Group
133
    server: D-Bus Server
237.2.101 by Teddy Hogeborn
* mandos: Minor doc string fixes.
134
    bus: dbus.SystemBus()
28 by Teddy Hogeborn
* server.conf: New file.
135
    """
136
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
137
                 servicetype = None, port = None, TXT = None,
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
138
                 domain = u"", host = u"", max_renames = 32768,
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
139
                 protocol = avahi.PROTO_UNSPEC, bus = None):
28 by Teddy Hogeborn
* server.conf: New file.
140
        self.interface = interface
141
        self.name = name
215 by Teddy Hogeborn
* mandos: Remove unused "select" module. Import "ctypes.util".
142
        self.type = servicetype
28 by Teddy Hogeborn
* server.conf: New file.
143
        self.port = port
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
144
        self.TXT = TXT if TXT is not None else []
28 by Teddy Hogeborn
* server.conf: New file.
145
        self.domain = domain
146
        self.host = host
147
        self.rename_count = 0
76 by Teddy Hogeborn
* plugins.d/password-request.c (init_gnutls_global): Renamed
148
        self.max_renames = max_renames
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
149
        self.protocol = protocol
237.2.99 by Teddy Hogeborn
Code cleanup.
150
        self.group = None       # our entry group
151
        self.server = None
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
152
        self.bus = bus
28 by Teddy Hogeborn
* server.conf: New file.
153
    def rename(self):
154
        """Derived from the Avahi example code"""
155
        if self.rename_count >= self.max_renames:
109 by Teddy Hogeborn
* .bzrignore: New.
156
            logger.critical(u"No suitable Zeroconf service name found"
157
                            u" after %i retries, exiting.",
215 by Teddy Hogeborn
* mandos: Remove unused "select" module. Import "ctypes.util".
158
                            self.rename_count)
237.2.5 by Teddy Hogeborn
* mandos (AvahiError): Converted to use unicode. All users changed.
159
            raise AvahiServiceError(u"Too many renames")
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
160
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
109 by Teddy Hogeborn
* .bzrignore: New.
161
        logger.info(u"Changing Zeroconf service name to %r ...",
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
162
                    self.name)
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
163
        syslogger.setFormatter(logging.Formatter
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
164
                               (u'Mandos (%s) [%%(process)d]:'
165
                                u' %%(levelname)s: %%(message)s'
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
166
                                % self.name))
28 by Teddy Hogeborn
* server.conf: New file.
167
        self.remove()
24.1.160 by Björn Påhlsson
fixed bug with local name collisions after a non-local name collision
168
        try:
169
            self.add()
170
        except dbus.exceptions.DBusException, error:
171
            logger.critical(u"DBusException: %s", error)
172
            self.cleanup()
173
            os._exit(1)
28 by Teddy Hogeborn
* server.conf: New file.
174
        self.rename_count += 1
175
    def remove(self):
176
        """Derived from the Avahi example code"""
237.2.99 by Teddy Hogeborn
Code cleanup.
177
        if self.group is not None:
178
            self.group.Reset()
28 by Teddy Hogeborn
* server.conf: New file.
179
    def add(self):
180
        """Derived from the Avahi example code"""
237.2.99 by Teddy Hogeborn
Code cleanup.
181
        if self.group is None:
182
            self.group = dbus.Interface(
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
183
                self.bus.get_object(avahi.DBUS_NAME,
184
                                    self.server.EntryGroupNew()),
237.2.99 by Teddy Hogeborn
Code cleanup.
185
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
186
            self.group.connect_to_signal('StateChanged',
237.2.142 by Teddy Hogeborn
* mandos: Fix line lengths.
187
                                         self
188
                                         .entry_group_state_changed)
109 by Teddy Hogeborn
* .bzrignore: New.
189
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
237.2.99 by Teddy Hogeborn
Code cleanup.
190
                     self.name, self.type)
191
        self.group.AddService(
192
            self.interface,
193
            self.protocol,
194
            dbus.UInt32(0),     # flags
195
            self.name, self.type,
196
            self.domain, self.host,
197
            dbus.UInt16(self.port),
198
            avahi.string_array_to_txt_array(self.TXT))
199
        self.group.Commit()
200
    def entry_group_state_changed(self, state, error):
201
        """Derived from the Avahi example code"""
237.2.180 by Teddy Hogeborn
* mandos (AvahiService.entry_group_state_changed): Better debug log
202
        logger.debug(u"Avahi entry group state change: %i", state)
237.2.99 by Teddy Hogeborn
Code cleanup.
203
        
204
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
            logger.debug(u"Zeroconf service established.")
206
        elif state == avahi.ENTRY_GROUP_COLLISION:
207
            logger.warning(u"Zeroconf service name collision.")
208
            self.rename()
209
        elif state == avahi.ENTRY_GROUP_FAILURE:
210
            logger.critical(u"Avahi: Error in group state changed %s",
211
                            unicode(error))
212
            raise AvahiGroupError(u"State changed: %s"
213
                                  % unicode(error))
214
    def cleanup(self):
215
        """Derived from the Avahi example code"""
216
        if self.group is not None:
217
            self.group.Free()
218
            self.group = None
219
    def server_state_changed(self, state):
220
        """Derived from the Avahi example code"""
237.2.180 by Teddy Hogeborn
* mandos (AvahiService.entry_group_state_changed): Better debug log
221
        logger.debug(u"Avahi server state change: %i", state)
237.2.99 by Teddy Hogeborn
Code cleanup.
222
        if state == avahi.SERVER_COLLISION:
223
            logger.error(u"Zeroconf server name collision")
224
            self.remove()
225
        elif state == avahi.SERVER_RUNNING:
226
            self.add()
227
    def activate(self):
228
        """Derived from the Avahi example code"""
229
        if self.server is None:
230
            self.server = dbus.Interface(
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
231
                self.bus.get_object(avahi.DBUS_NAME,
232
                                    avahi.DBUS_PATH_SERVER),
237.2.99 by Teddy Hogeborn
Code cleanup.
233
                avahi.DBUS_INTERFACE_SERVER)
234
        self.server.connect_to_signal(u"StateChanged",
235
                                 self.server_state_changed)
236
        self.server_state_changed(self.server.GetState())
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
237
238
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
239
class Client(object):
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
240
    """A representation of a client host served by this server.
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
241
    
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
242
    Attributes:
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
243
    _approved:   bool(); 'None' if not yet approved/disapproved
244
    approval_delay: datetime.timedelta(); Time to wait for approval
245
    approval_duration: datetime.timedelta(); Duration of one approval
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
246
    checker:    subprocess.Popen(); a running checker process used
247
                                    to see if the client lives.
248
                                    'None' if no process is running.
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
249
    checker_callback_tag: a gobject event source tag, or None
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
250
    checker_command: string; External command which is run to check
251
                     if client lives.  %() expansions are done at
12 by Teddy Hogeborn
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
252
                     runtime with vars(self) as dict, so that for
253
                     instance %(name)s can be used in the command.
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
254
    checker_initiator_tag: a gobject event source tag, or None
255
    created:    datetime.datetime(); (UTC) object creation
237.2.78 by Teddy Hogeborn
* mandos (Client.current_checker_command): New attribute.
256
    current_checker_command: string; current running checker_command
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
257
    disable_hook:  If set, called by disable() as disable_hook(self)
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
258
    disable_initiator_tag: a gobject event source tag, or None
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
259
    enabled:    bool()
260
    fingerprint: string (40 or 32 hexadecimal digits); used to
261
                 uniquely identify the client
262
    host:       string; available for use by the checker command
263
    interval:   datetime.timedelta(); How often to start a new checker
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
264
    last_approval_request: datetime.datetime(); (UTC) or None
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
265
    last_checked_ok: datetime.datetime(); (UTC) or None
266
    last_enabled: datetime.datetime(); (UTC)
267
    name:       string; from the config file, used in log messages and
268
                        D-Bus identifiers
269
    secret:     bytestring; sent verbatim (over TLS) to client
270
    timeout:    datetime.timedelta(); How long from last_checked_ok
271
                                      until this client is disabled
272
    runtime_expansions: Allowed attributes for runtime expansion.
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
273
    """
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
274
    
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
275
    runtime_expansions = (u"approval_delay", u"approval_duration",
276
                          u"created", u"enabled", u"fingerprint",
277
                          u"host", u"interval", u"last_checked_ok",
278
                          u"last_enabled", u"name", u"timeout")
279
    
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
280
    @staticmethod
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
281
    def _timedelta_to_milliseconds(td):
282
        "Convert a datetime.timedelta() to milliseconds"
283
        return ((td.days * 24 * 60 * 60 * 1000)
284
                + (td.seconds * 1000)
285
                + (td.microseconds // 1000))
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
286
    
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
287
    def timeout_milliseconds(self):
288
        "Return the 'timeout' attribute in milliseconds"
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
289
        return self._timedelta_to_milliseconds(self.timeout)
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
290
    
291
    def interval_milliseconds(self):
292
        "Return the 'interval' attribute in milliseconds"
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
293
        return self._timedelta_to_milliseconds(self.interval)
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
294
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
295
    def approval_delay_milliseconds(self):
296
        return self._timedelta_to_milliseconds(self.approval_delay)
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
297
    
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
298
    def __init__(self, name = None, disable_hook=None, config=None):
45 by Teddy Hogeborn
* server.py: Cosmetic changes.
299
        """Note: the 'checker' key in 'config' sets the
300
        'checker_command' attribute and *not* the 'checker'
301
        attribute."""
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
302
        self.name = name
215 by Teddy Hogeborn
* mandos: Remove unused "select" module. Import "ctypes.util".
303
        if config is None:
304
            config = {}
25 by Teddy Hogeborn
* mandos-clients.conf ([DEFAULT]): New section.
305
        logger.debug(u"Creating client %r", self.name)
45 by Teddy Hogeborn
* server.py: Cosmetic changes.
306
        # Uppercase and remove spaces from fingerprint for later
307
        # comparison purposes with return value from the fingerprint()
308
        # function
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
309
        self.fingerprint = (config[u"fingerprint"].upper()
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
310
                            .replace(u" ", u""))
25 by Teddy Hogeborn
* mandos-clients.conf ([DEFAULT]): New section.
311
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
312
        if u"secret" in config:
313
            self.secret = config[u"secret"].decode(u"base64")
314
        elif u"secfile" in config:
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
315
            with open(os.path.expanduser(os.path.expandvars
316
                                         (config[u"secfile"])),
317
                      "rb") as secfile:
237 by Teddy Hogeborn
* mandos: Also import "with_statement" and "absolute_import" from
318
                self.secret = secfile.read()
3 by Björn Påhlsson
Python based server
319
        else:
28 by Teddy Hogeborn
* server.conf: New file.
320
            raise TypeError(u"No secret or secfile for client %s"
321
                            % self.name)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
322
        self.host = config.get(u"host", u"")
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
323
        self.created = datetime.datetime.utcnow()
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
324
        self.enabled = False
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
325
        self.last_approval_request = None
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
326
        self.last_enabled = None
28 by Teddy Hogeborn
* server.conf: New file.
327
        self.last_checked_ok = None
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
328
        self.timeout = string_to_delta(config[u"timeout"])
329
        self.interval = string_to_delta(config[u"interval"])
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
330
        self.disable_hook = disable_hook
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
331
        self.checker = None
332
        self.checker_initiator_tag = None
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
333
        self.disable_initiator_tag = None
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
334
        self.checker_callback_tag = None
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
335
        self.checker_command = config[u"checker"]
237.2.78 by Teddy Hogeborn
* mandos (Client.current_checker_command): New attribute.
336
        self.current_checker_command = None
237.2.42 by Teddy Hogeborn
* mandos (Client.__init__): Disable D-Bus during init to avoid
337
        self.last_connect = None
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
338
        self._approved = None
339
        self.approved_by_default = config.get(u"approved_by_default",
24.2.1 by teddy at bsnet
* debian/control (mandos/Depends): Added "python-urwid".
340
                                              True)
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
341
        self.approvals_pending = 0
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
342
        self.approval_delay = string_to_delta(
343
            config[u"approval_delay"])
344
        self.approval_duration = string_to_delta(
345
            config[u"approval_duration"])
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
346
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
347
    
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
348
    def send_changedstate(self):
349
        self.changedstate.acquire()
350
        self.changedstate.notify_all()
351
        self.changedstate.release()
352
        
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
353
    def enable(self):
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
354
        """Start this client's checker and timeout hooks"""
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
355
        if getattr(self, u"enabled", False):
356
            # Already enabled
357
            return
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
358
        self.send_changedstate()
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
359
        self.last_enabled = datetime.datetime.utcnow()
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
360
        # Schedule a new checker to be started an 'interval' from now,
361
        # and every interval from then on.
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
362
        self.checker_initiator_tag = (gobject.timeout_add
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
363
                                      (self.interval_milliseconds(),
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
364
                                       self.start_checker))
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
365
        # Schedule a disable() when 'timeout' has passed
366
        self.disable_initiator_tag = (gobject.timeout_add
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
367
                                   (self.timeout_milliseconds(),
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
368
                                    self.disable))
369
        self.enabled = True
237.2.163 by Teddy Hogeborn
* mandos (Client.enable): Bug fix: Start new immediate checker last to
370
        # Also start a new checker *right now*.
371
        self.start_checker()
237.1.1 by Teddy Hogeborn
First steps of a D-Bus interface to the server.
372
    
237.2.165 by Teddy Hogeborn
* mandos (Client.disable): Rename keyword argument "log" to "quiet",
373
    def disable(self, quiet=True):
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
374
        """Disable this client."""
375
        if not getattr(self, "enabled", False):
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
376
            return False
237.2.165 by Teddy Hogeborn
* mandos (Client.disable): Rename keyword argument "log" to "quiet",
377
        if not quiet:
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
378
            self.send_changedstate()
379
        if not quiet:
237.2.163 by Teddy Hogeborn
* mandos (Client.enable): Bug fix: Start new immediate checker last to
380
            logger.info(u"Disabling client %s", self.name)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
381
        if getattr(self, u"disable_initiator_tag", False):
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
382
            gobject.source_remove(self.disable_initiator_tag)
383
            self.disable_initiator_tag = None
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
384
        if getattr(self, u"checker_initiator_tag", False):
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
385
            gobject.source_remove(self.checker_initiator_tag)
386
            self.checker_initiator_tag = None
387
        self.stop_checker()
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
388
        if self.disable_hook:
389
            self.disable_hook(self)
390
        self.enabled = False
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
391
        # Do not run this again if called by a gobject.timeout_add
392
        return False
237.1.1 by Teddy Hogeborn
First steps of a D-Bus interface to the server.
393
    
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
394
    def __del__(self):
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
395
        self.disable_hook = None
396
        self.disable()
237.1.1 by Teddy Hogeborn
First steps of a D-Bus interface to the server.
397
    
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
398
    def checker_callback(self, pid, condition, command):
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
399
        """The checker has completed, so take appropriate actions."""
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
400
        self.checker_callback_tag = None
401
        self.checker = None
237.2.43 by Teddy Hogeborn
* mandos (Client.CheckerCompleted): Changed signature to "nxs"; return
402
        if os.WIFEXITED(condition):
403
            exitstatus = os.WEXITSTATUS(condition)
404
            if exitstatus == 0:
405
                logger.info(u"Checker for %(name)s succeeded",
406
                            vars(self))
237.2.44 by Teddy Hogeborn
* mandos (Client.bump_timeout): Renamed to "checked_ok". All callers
407
                self.checked_ok()
237.2.43 by Teddy Hogeborn
* mandos (Client.CheckerCompleted): Changed signature to "nxs"; return
408
            else:
409
                logger.info(u"Checker for %(name)s failed",
410
                            vars(self))
411
        else:
13 by Björn Påhlsson
Added following support:
412
            logger.warning(u"Checker for %(name)s crashed?",
413
                           vars(self))
237.1.1 by Teddy Hogeborn
First steps of a D-Bus interface to the server.
414
    
237.2.44 by Teddy Hogeborn
* mandos (Client.bump_timeout): Renamed to "checked_ok". All callers
415
    def checked_ok(self):
237 by Teddy Hogeborn
* mandos: Also import "with_statement" and "absolute_import" from
416
        """Bump up the timeout for this client.
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
417
        
237 by Teddy Hogeborn
* mandos: Also import "with_statement" and "absolute_import" from
418
        This should only be called when the client has been seen,
419
        alive and well.
420
        """
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
421
        self.last_checked_ok = datetime.datetime.utcnow()
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
422
        gobject.source_remove(self.disable_initiator_tag)
423
        self.disable_initiator_tag = (gobject.timeout_add
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
424
                                      (self.timeout_milliseconds(),
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
425
                                       self.disable))
237.1.1 by Teddy Hogeborn
First steps of a D-Bus interface to the server.
426
    
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
427
    def need_approval(self):
428
        self.last_approval_request = datetime.datetime.utcnow()
429
    
9 by Teddy Hogeborn
* client.cpp (main): Get t_old early since it is used on error exits.
430
    def start_checker(self):
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
431
        """Start a new checker subprocess if one is not running.
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
432
        
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
433
        If a checker already exists, leave it running and do
434
        nothing."""
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
435
        # The reason for not killing a running checker is that if we
436
        # did that, then if a checker (for some reason) started
437
        # running slowly and taking more than 'interval' time, the
438
        # client would inevitably timeout, since no checker would get
439
        # a chance to run to completion.  If we instead leave running
440
        # checkers alone, the checker would have to take more time
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
441
        # than 'timeout' for the client to be disabled, which is as it
442
        # should be.
237.2.78 by Teddy Hogeborn
* mandos (Client.current_checker_command): New attribute.
443
        
444
        # If a checker exists, make sure it is not a zombie
237.2.146 by Teddy Hogeborn
* mandos (Client.start_checker): Bug fix: Fix race condition with
445
        try:
237.2.78 by Teddy Hogeborn
* mandos (Client.current_checker_command): New attribute.
446
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
237.2.146 by Teddy Hogeborn
* mandos (Client.start_checker): Bug fix: Fix race condition with
447
        except (AttributeError, OSError), error:
448
            if (isinstance(error, OSError)
449
                and error.errno != errno.ECHILD):
450
                raise error
451
        else:
237.2.78 by Teddy Hogeborn
* mandos (Client.current_checker_command): New attribute.
452
            if pid:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
453
                logger.warning(u"Checker was a zombie")
237.2.78 by Teddy Hogeborn
* mandos (Client.current_checker_command): New attribute.
454
                gobject.source_remove(self.checker_callback_tag)
455
                self.checker_callback(pid, status,
456
                                      self.current_checker_command)
457
        # Start a new checker if needed
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
458
        if self.checker is None:
12 by Teddy Hogeborn
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
459
            try:
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
460
                # In case checker_command has exactly one % operator
461
                command = self.checker_command % self.host
12 by Teddy Hogeborn
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
462
            except TypeError:
28 by Teddy Hogeborn
* server.conf: New file.
463
                # Escape attributes for the shell
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
464
                escaped_attrs = dict(
465
                    (attr,
466
                     re.escape(unicode(str(getattr(self, attr, u"")),
467
                                       errors=
468
                                       u'replace')))
469
                    for attr in
470
                    self.runtime_expansions)
471
13 by Björn Påhlsson
Added following support:
472
                try:
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
473
                    command = self.checker_command % escaped_attrs
13 by Björn Påhlsson
Added following support:
474
                except TypeError, error:
28 by Teddy Hogeborn
* server.conf: New file.
475
                    logger.error(u'Could not format string "%s":'
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
476
                                 u' %s', self.checker_command, error)
13 by Björn Påhlsson
Added following support:
477
                    return True # Try again later
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
478
            self.current_checker_command = command
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
479
            try:
44 by Teddy Hogeborn
* ca.pem: Removed.
480
                logger.info(u"Starting checker %r for %s",
481
                            command, self.name)
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
482
                # We don't need to redirect stdout and stderr, since
483
                # in normal mode, that is already done by daemon(),
484
                # and in debug mode we don't want to.  (Stdin is
485
                # always replaced by /dev/null.)
28 by Teddy Hogeborn
* server.conf: New file.
486
                self.checker = subprocess.Popen(command,
487
                                                close_fds=True,
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
488
                                                shell=True, cwd=u"/")
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
489
                self.checker_callback_tag = (gobject.child_watch_add
490
                                             (self.checker.pid,
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
491
                                              self.checker_callback,
492
                                              data=command))
237.2.73 by Teddy Hogeborn
* mandos (Client.start_checker): Bug fix: Add extra check in case the
493
                # The checker may have completed before the gobject
494
                # watch was added.  Check for this.
495
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
496
                if pid:
497
                    gobject.source_remove(self.checker_callback_tag)
498
                    self.checker_callback(pid, status, command)
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
499
            except OSError, error:
13 by Björn Påhlsson
Added following support:
500
                logger.error(u"Failed to start subprocess: %s",
501
                             error)
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
502
        # Re-run this periodically if run by gobject.timeout_add
503
        return True
237.1.1 by Teddy Hogeborn
First steps of a D-Bus interface to the server.
504
    
9 by Teddy Hogeborn
* client.cpp (main): Get t_old early since it is used on error exits.
505
    def stop_checker(self):
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
506
        """Force the checker process, if any, to stop."""
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
507
        if self.checker_callback_tag:
508
            gobject.source_remove(self.checker_callback_tag)
509
            self.checker_callback_tag = None
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
510
        if getattr(self, u"checker", None) is None:
9 by Teddy Hogeborn
* client.cpp (main): Get t_old early since it is used on error exits.
511
            return
51 by Teddy Hogeborn
* clients.conf: Better comments.
512
        logger.debug(u"Stopping checker for %(name)s", vars(self))
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
513
        try:
514
            os.kill(self.checker.pid, signal.SIGTERM)
237.2.163 by Teddy Hogeborn
* mandos (Client.enable): Bug fix: Start new immediate checker last to
515
            #time.sleep(0.5)
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
516
            #if self.checker.poll() is None:
517
            #    os.kill(self.checker.pid, signal.SIGKILL)
518
        except OSError, error:
28 by Teddy Hogeborn
* server.conf: New file.
519
            if error.errno != errno.ESRCH: # No such process
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
520
                raise
9 by Teddy Hogeborn
* client.cpp (main): Get t_old early since it is used on error exits.
521
        self.checker = None
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
522
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
523
def dbus_service_property(dbus_interface, signature=u"v",
524
                          access=u"readwrite", byte_arrays=False):
525
    """Decorators for marking methods of a DBusObjectWithProperties to
526
    become properties on the D-Bus.
527
    
528
    The decorated method will be called with no arguments by "Get"
529
    and with one argument by "Set".
530
    
531
    The parameters, where they are supported, are the same as
532
    dbus.service.method, except there is only "signature", since the
533
    type from Get() and the type sent to Set() is the same.
534
    """
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
535
    # Encoding deeply encoded byte arrays is not supported yet by the
536
    # "Set" method, so we fail early here:
537
    if byte_arrays and signature != u"ay":
538
        raise ValueError(u"Byte arrays not supported for non-'ay'"
539
                         u" signature %r" % signature)
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
540
    def decorator(func):
541
        func._dbus_is_property = True
542
        func._dbus_interface = dbus_interface
543
        func._dbus_signature = signature
544
        func._dbus_access = access
545
        func._dbus_name = func.__name__
546
        if func._dbus_name.endswith(u"_dbus_property"):
547
            func._dbus_name = func._dbus_name[:-14]
548
        func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
549
        return func
550
    return decorator
551
552
553
class DBusPropertyException(dbus.exceptions.DBusException):
554
    """A base class for D-Bus property-related exceptions
555
    """
556
    def __unicode__(self):
557
        return unicode(str(self))
558
559
560
class DBusPropertyAccessException(DBusPropertyException):
561
    """A property's access permissions disallows an operation.
562
    """
563
    pass
564
565
566
class DBusPropertyNotFound(DBusPropertyException):
567
    """An attempt was made to access a non-existing property.
568
    """
569
    pass
570
571
572
class DBusObjectWithProperties(dbus.service.Object):
573
    """A D-Bus object with properties.
574
575
    Classes inheriting from this can use the dbus_service_property
576
    decorator to expose methods as D-Bus properties.  It exposes the
577
    standard Get(), Set(), and GetAll() methods on the D-Bus.
578
    """
579
    
580
    @staticmethod
581
    def _is_dbus_property(obj):
582
        return getattr(obj, u"_dbus_is_property", False)
583
    
584
    def _get_all_dbus_properties(self):
585
        """Returns a generator of (name, attribute) pairs
586
        """
587
        return ((prop._dbus_name, prop)
588
                for name, prop in
589
                inspect.getmembers(self, self._is_dbus_property))
590
    
591
    def _get_dbus_property(self, interface_name, property_name):
592
        """Returns a bound method if one exists which is a D-Bus
593
        property with the specified name and interface.
594
        """
595
        for name in (property_name,
596
                     property_name + u"_dbus_property"):
597
            prop = getattr(self, name, None)
598
            if (prop is None
599
                or not self._is_dbus_property(prop)
600
                or prop._dbus_name != property_name
601
                or (interface_name and prop._dbus_interface
602
                    and interface_name != prop._dbus_interface)):
603
                continue
604
            return prop
605
        # No such property
606
        raise DBusPropertyNotFound(self.dbus_object_path + u":"
607
                                   + interface_name + u"."
608
                                   + property_name)
609
    
610
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
611
                         out_signature=u"v")
612
    def Get(self, interface_name, property_name):
613
        """Standard D-Bus property Get() method, see D-Bus standard.
614
        """
615
        prop = self._get_dbus_property(interface_name, property_name)
616
        if prop._dbus_access == u"write":
617
            raise DBusPropertyAccessException(property_name)
618
        value = prop()
619
        if not hasattr(value, u"variant_level"):
620
            return value
621
        return type(value)(value, variant_level=value.variant_level+1)
622
    
623
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
624
    def Set(self, interface_name, property_name, value):
625
        """Standard D-Bus property Set() method, see D-Bus standard.
626
        """
627
        prop = self._get_dbus_property(interface_name, property_name)
628
        if prop._dbus_access == u"read":
629
            raise DBusPropertyAccessException(property_name)
630
        if prop._dbus_get_args_options[u"byte_arrays"]:
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
631
            # The byte_arrays option is not supported yet on
632
            # signatures other than "ay".
633
            if prop._dbus_signature != u"ay":
634
                raise ValueError
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
635
            value = dbus.ByteArray(''.join(unichr(byte)
636
                                           for byte in value))
637
        prop(value)
638
    
639
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
640
                         out_signature=u"a{sv}")
641
    def GetAll(self, interface_name):
642
        """Standard D-Bus property GetAll() method, see D-Bus
643
        standard.
644
645
        Note: Will not include properties with access="write".
646
        """
647
        all = {}
648
        for name, prop in self._get_all_dbus_properties():
649
            if (interface_name
650
                and interface_name != prop._dbus_interface):
651
                # Interface non-empty but did not match
652
                continue
653
            # Ignore write-only properties
654
            if prop._dbus_access == u"write":
655
                continue
656
            value = prop()
657
            if not hasattr(value, u"variant_level"):
658
                all[name] = value
659
                continue
660
            all[name] = type(value)(value, variant_level=
661
                                    value.variant_level+1)
662
        return dbus.Dictionary(all, signature=u"sv")
663
    
664
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
665
                         out_signature=u"s",
666
                         path_keyword='object_path',
667
                         connection_keyword='connection')
668
    def Introspect(self, object_path, connection):
669
        """Standard D-Bus method, overloaded to insert property tags.
670
        """
671
        xmlstring = dbus.service.Object.Introspect(self, object_path,
237.2.149 by Teddy Hogeborn
* mandos (DBusObjectWithProperties.Introspect): Add the name
672
                                                   connection)
237.2.150 by Teddy Hogeborn
* mandos (ClientDBus.ReceivedSecret): Renamed to "GotSecret". All
673
        try:
674
            document = xml.dom.minidom.parseString(xmlstring)
675
            def make_tag(document, name, prop):
676
                e = document.createElement(u"property")
677
                e.setAttribute(u"name", name)
678
                e.setAttribute(u"type", prop._dbus_signature)
679
                e.setAttribute(u"access", prop._dbus_access)
680
                return e
681
            for if_tag in document.getElementsByTagName(u"interface"):
682
                for tag in (make_tag(document, name, prop)
683
                            for name, prop
684
                            in self._get_all_dbus_properties()
685
                            if prop._dbus_interface
686
                            == if_tag.getAttribute(u"name")):
687
                    if_tag.appendChild(tag)
688
                # Add the names to the return values for the
689
                # "org.freedesktop.DBus.Properties" methods
690
                if (if_tag.getAttribute(u"name")
691
                    == u"org.freedesktop.DBus.Properties"):
692
                    for cn in if_tag.getElementsByTagName(u"method"):
693
                        if cn.getAttribute(u"name") == u"Get":
694
                            for arg in cn.getElementsByTagName(u"arg"):
695
                                if (arg.getAttribute(u"direction")
696
                                    == u"out"):
697
                                    arg.setAttribute(u"name", u"value")
698
                        elif cn.getAttribute(u"name") == u"GetAll":
699
                            for arg in cn.getElementsByTagName(u"arg"):
700
                                if (arg.getAttribute(u"direction")
701
                                    == u"out"):
702
                                    arg.setAttribute(u"name", u"props")
703
            xmlstring = document.toxml(u"utf-8")
704
            document.unlink()
705
        except (AttributeError, xml.dom.DOMException,
706
                xml.parsers.expat.ExpatError), error:
707
            logger.error(u"Failed to override Introspection method",
708
                         error)
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
709
        return xmlstring
710
711
712
class ClientDBus(Client, DBusObjectWithProperties):
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
713
    """A Client class using D-Bus
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
714
    
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
715
    Attributes:
237.2.101 by Teddy Hogeborn
* mandos: Minor doc string fixes.
716
    dbus_object_path: dbus.ObjectPath
717
    bus: dbus.SystemBus()
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
718
    """
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
719
    
720
    runtime_expansions = (Client.runtime_expansions
721
                          + (u"dbus_object_path",))
722
    
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
723
    # dbus.service.Object doesn't use super(), so we can't either.
724
    
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
725
    def __init__(self, bus = None, *args, **kwargs):
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
726
        self._approvals_pending = 0
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
727
        self.bus = bus
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
728
        Client.__init__(self, *args, **kwargs)
729
        # Only now, when this client is initialized, can it show up on
730
        # the D-Bus
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
731
        client_object_name = unicode(self.name).translate(
732
            {ord(u"."): ord(u"_"),
733
             ord(u"-"): ord(u"_")})
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
734
        self.dbus_object_path = (dbus.ObjectPath
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
735
                                 (u"/clients/" + client_object_name))
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
736
        DBusObjectWithProperties.__init__(self, self.bus,
737
                                          self.dbus_object_path)
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
738
        
24.1.154 by Björn Påhlsson
merge
739
    def _get_approvals_pending(self):
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
740
        return self._approvals_pending
24.2.5 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Bug fix: Only send D-Bus
741
    def _set_approvals_pending(self, value):
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
742
        old_value = self._approvals_pending
743
        self._approvals_pending = value
744
        bval = bool(value)
24.2.5 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Bug fix: Only send D-Bus
745
        if (hasattr(self, "dbus_object_path")
24.1.154 by Björn Påhlsson
merge
746
            and bval is not bool(old_value)):
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
747
            dbus_bool = dbus.Boolean(bval, variant_level=1)
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
748
            self.PropertyChanged(dbus.String(u"ApprovalPending"),
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
749
                                 dbus_bool)
24.1.154 by Björn Påhlsson
merge
750
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
751
    approvals_pending = property(_get_approvals_pending,
752
                                 _set_approvals_pending)
753
    del _get_approvals_pending, _set_approvals_pending
754
    
237.2.99 by Teddy Hogeborn
Code cleanup.
755
    @staticmethod
756
    def _datetime_to_dbus(dt, variant_level=0):
757
        """Convert a UTC datetime.datetime() to a D-Bus type."""
758
        return dbus.String(dt.isoformat(),
759
                           variant_level=variant_level)
760
    
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
761
    def enable(self):
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
762
        oldstate = getattr(self, u"enabled", False)
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
763
        r = Client.enable(self)
764
        if oldstate != self.enabled:
765
            # Emit D-Bus signals
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
766
            self.PropertyChanged(dbus.String(u"Enabled"),
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
767
                                 dbus.Boolean(True, variant_level=1))
237.2.99 by Teddy Hogeborn
Code cleanup.
768
            self.PropertyChanged(
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
769
                dbus.String(u"LastEnabled"),
237.2.99 by Teddy Hogeborn
Code cleanup.
770
                self._datetime_to_dbus(self.last_enabled,
771
                                       variant_level=1))
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
772
        return r
773
    
237.2.165 by Teddy Hogeborn
* mandos (Client.disable): Rename keyword argument "log" to "quiet",
774
    def disable(self, quiet = False):
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
775
        oldstate = getattr(self, u"enabled", False)
237.2.166 by Teddy Hogeborn
* mandos (ClientDBus.disable): Bug fix: complete rename of "log" and
776
        r = Client.disable(self, quiet=quiet)
237.2.165 by Teddy Hogeborn
* mandos (Client.disable): Rename keyword argument "log" to "quiet",
777
        if not quiet and oldstate != self.enabled:
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
778
            # Emit D-Bus signal
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
779
            self.PropertyChanged(dbus.String(u"Enabled"),
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
780
                                 dbus.Boolean(False, variant_level=1))
781
        return r
782
    
783
    def __del__(self, *args, **kwargs):
784
        try:
785
            self.remove_from_connection()
237.2.92 by Teddy Hogeborn
* mandos (ClientDBus.__del__): Bug fix: Correct mispasted code, and do
786
        except LookupError:
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
787
            pass
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
788
        if hasattr(DBusObjectWithProperties, u"__del__"):
789
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
790
        Client.__del__(self, *args, **kwargs)
791
    
792
    def checker_callback(self, pid, condition, command,
793
                         *args, **kwargs):
794
        self.checker_callback_tag = None
795
        self.checker = None
796
        # Emit D-Bus signal
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
797
        self.PropertyChanged(dbus.String(u"CheckerRunning"),
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
798
                             dbus.Boolean(False, variant_level=1))
799
        if os.WIFEXITED(condition):
800
            exitstatus = os.WEXITSTATUS(condition)
801
            # Emit D-Bus signal
802
            self.CheckerCompleted(dbus.Int16(exitstatus),
803
                                  dbus.Int64(condition),
804
                                  dbus.String(command))
805
        else:
806
            # Emit D-Bus signal
807
            self.CheckerCompleted(dbus.Int16(-1),
808
                                  dbus.Int64(condition),
809
                                  dbus.String(command))
810
        
811
        return Client.checker_callback(self, pid, condition, command,
812
                                       *args, **kwargs)
813
    
814
    def checked_ok(self, *args, **kwargs):
815
        r = Client.checked_ok(self, *args, **kwargs)
816
        # Emit D-Bus signal
817
        self.PropertyChanged(
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
818
            dbus.String(u"LastCheckedOK"),
237.2.99 by Teddy Hogeborn
Code cleanup.
819
            (self._datetime_to_dbus(self.last_checked_ok,
820
                                    variant_level=1)))
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
821
        return r
822
    
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
823
    def need_approval(self, *args, **kwargs):
824
        r = Client.need_approval(self, *args, **kwargs)
825
        # Emit D-Bus signal
826
        self.PropertyChanged(
827
            dbus.String(u"LastApprovalRequest"),
828
            (self._datetime_to_dbus(self.last_approval_request,
829
                                    variant_level=1)))
830
        return r
831
    
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
832
    def start_checker(self, *args, **kwargs):
833
        old_checker = self.checker
834
        if self.checker is not None:
835
            old_checker_pid = self.checker.pid
836
        else:
837
            old_checker_pid = None
838
        r = Client.start_checker(self, *args, **kwargs)
237.2.92 by Teddy Hogeborn
* mandos (ClientDBus.__del__): Bug fix: Correct mispasted code, and do
839
        # Only if new checker process was started
840
        if (self.checker is not None
841
            and old_checker_pid != self.checker.pid):
842
            # Emit D-Bus signal
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
843
            self.CheckerStarted(self.current_checker_command)
844
            self.PropertyChanged(
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
845
                dbus.String(u"CheckerRunning"),
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
846
                dbus.Boolean(True, variant_level=1))
847
        return r
848
    
849
    def stop_checker(self, *args, **kwargs):
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
850
        old_checker = getattr(self, u"checker", None)
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
851
        r = Client.stop_checker(self, *args, **kwargs)
852
        if (old_checker is not None
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
853
            and getattr(self, u"checker", None) is None):
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
854
            self.PropertyChanged(dbus.String(u"CheckerRunning"),
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
855
                                 dbus.Boolean(False, variant_level=1))
856
        return r
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
857
858
    def _reset_approved(self):
859
        self._approved = None
860
        return False
861
    
862
    def approve(self, value=True):
24.1.154 by Björn Påhlsson
merge
863
        self.send_changedstate()
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
864
        self._approved = value
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
865
        gobject.timeout_add(self._timedelta_to_milliseconds
866
                            (self.approval_duration),
24.1.154 by Björn Påhlsson
merge
867
                            self._reset_approved)
24.2.1 by teddy at bsnet
* debian/control (mandos/Depends): Added "python-urwid".
868
    
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
869
    
24.1.147 by Björn Påhlsson
The IPC pipes are now file objects, not file descriptors:
870
    ## D-Bus methods, signals & properties
237.2.42 by Teddy Hogeborn
* mandos (Client.__init__): Disable D-Bus during init to avoid
871
    _interface = u"se.bsnet.fukt.Mandos.Client"
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
872
    
24.1.147 by Björn Påhlsson
The IPC pipes are now file objects, not file descriptors:
873
    ## Signals
237.2.144 by Teddy Hogeborn
Restore some poor D-Bus methods who got a bit hastily deleted. Enable
874
    
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
875
    # CheckerCompleted - signal
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
876
    @dbus.service.signal(_interface, signature=u"nxs")
237.2.43 by Teddy Hogeborn
* mandos (Client.CheckerCompleted): Changed signature to "nxs"; return
877
    def CheckerCompleted(self, exitcode, waitstatus, command):
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
878
        "D-Bus signal"
879
        pass
880
    
881
    # CheckerStarted - signal
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
882
    @dbus.service.signal(_interface, signature=u"s")
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
883
    def CheckerStarted(self, command):
884
        "D-Bus signal"
885
        pass
886
    
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
887
    # PropertyChanged - signal
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
888
    @dbus.service.signal(_interface, signature=u"sv")
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
889
    def PropertyChanged(self, property, value):
890
        "D-Bus signal"
891
        pass
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
892
    
237.2.150 by Teddy Hogeborn
* mandos (ClientDBus.ReceivedSecret): Renamed to "GotSecret". All
893
    # GotSecret - signal
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
894
    @dbus.service.signal(_interface)
237.2.150 by Teddy Hogeborn
* mandos (ClientDBus.ReceivedSecret): Renamed to "GotSecret". All
895
    def GotSecret(self):
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
896
        """D-Bus signal
897
        Is sent after a successful transfer of secret from the Mandos
898
        server to mandos-client
899
        """
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
900
        pass
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
901
    
902
    # Rejected - signal
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
903
    @dbus.service.signal(_interface, signature=u"s")
904
    def Rejected(self, reason):
905
        "D-Bus signal"
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
906
        pass
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
907
    
908
    # NeedApproval - signal
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
909
    @dbus.service.signal(_interface, signature=u"tb")
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
910
    def NeedApproval(self, timeout, default):
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
911
        "D-Bus signal"
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
912
        return self.need_approval()
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
913
    
24.1.147 by Björn Påhlsson
The IPC pipes are now file objects, not file descriptors:
914
    ## Methods
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
915
    
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
916
    # Approve - method
917
    @dbus.service.method(_interface, in_signature=u"b")
918
    def Approve(self, value):
919
        self.approve(value)
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
920
    
24.1.147 by Björn Påhlsson
The IPC pipes are now file objects, not file descriptors:
921
    # CheckedOK - method
922
    @dbus.service.method(_interface)
923
    def CheckedOK(self):
924
        return self.checked_ok()
925
    
237.2.144 by Teddy Hogeborn
Restore some poor D-Bus methods who got a bit hastily deleted. Enable
926
    # Enable - method
927
    @dbus.service.method(_interface)
928
    def Enable(self):
929
        "D-Bus method"
930
        self.enable()
931
    
932
    # StartChecker - method
933
    @dbus.service.method(_interface)
934
    def StartChecker(self):
935
        "D-Bus method"
936
        self.start_checker()
937
    
938
    # Disable - method
939
    @dbus.service.method(_interface)
940
    def Disable(self):
941
        "D-Bus method"
942
        self.disable()
943
    
944
    # StopChecker - method
945
    @dbus.service.method(_interface)
946
    def StopChecker(self):
947
        self.stop_checker()
948
    
24.1.147 by Björn Påhlsson
The IPC pipes are now file objects, not file descriptors:
949
    ## Properties
950
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
951
    # ApprovalPending - property
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
952
    @dbus_service_property(_interface, signature=u"b", access=u"read")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
953
    def ApprovalPending_dbus_property(self):
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
954
        return dbus.Boolean(bool(self.approvals_pending))
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
955
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
956
    # ApprovedByDefault - property
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
957
    @dbus_service_property(_interface, signature=u"b",
958
                           access=u"readwrite")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
959
    def ApprovedByDefault_dbus_property(self, value=None):
960
        if value is None:       # get
961
            return dbus.Boolean(self.approved_by_default)
962
        self.approved_by_default = bool(value)
963
        # Emit D-Bus signal
964
        self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
965
                             dbus.Boolean(value, variant_level=1))
966
    
967
    # ApprovalDelay - property
968
    @dbus_service_property(_interface, signature=u"t",
969
                           access=u"readwrite")
970
    def ApprovalDelay_dbus_property(self, value=None):
971
        if value is None:       # get
972
            return dbus.UInt64(self.approval_delay_milliseconds())
973
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
974
        # Emit D-Bus signal
975
        self.PropertyChanged(dbus.String(u"ApprovalDelay"),
976
                             dbus.UInt64(value, variant_level=1))
977
    
978
    # ApprovalDuration - property
979
    @dbus_service_property(_interface, signature=u"t",
980
                           access=u"readwrite")
981
    def ApprovalDuration_dbus_property(self, value=None):
982
        if value is None:       # get
983
            return dbus.UInt64(self._timedelta_to_milliseconds(
984
                    self.approval_duration))
985
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
986
        # Emit D-Bus signal
987
        self.PropertyChanged(dbus.String(u"ApprovalDuration"),
988
                             dbus.UInt64(value, variant_level=1))
989
    
990
    # Name - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
991
    @dbus_service_property(_interface, signature=u"s", access=u"read")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
992
    def Name_dbus_property(self):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
993
        return dbus.String(self.name)
994
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
995
    # Fingerprint - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
996
    @dbus_service_property(_interface, signature=u"s", access=u"read")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
997
    def Fingerprint_dbus_property(self):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
998
        return dbus.String(self.fingerprint)
999
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1000
    # Host - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1001
    @dbus_service_property(_interface, signature=u"s",
1002
                           access=u"readwrite")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1003
    def Host_dbus_property(self, value=None):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1004
        if value is None:       # get
1005
            return dbus.String(self.host)
1006
        self.host = value
1007
        # Emit D-Bus signal
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1008
        self.PropertyChanged(dbus.String(u"Host"),
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1009
                             dbus.String(value, variant_level=1))
1010
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1011
    # Created - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1012
    @dbus_service_property(_interface, signature=u"s", access=u"read")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1013
    def Created_dbus_property(self):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1014
        return dbus.String(self._datetime_to_dbus(self.created))
1015
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1016
    # LastEnabled - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1017
    @dbus_service_property(_interface, signature=u"s", access=u"read")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1018
    def LastEnabled_dbus_property(self):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1019
        if self.last_enabled is None:
1020
            return dbus.String(u"")
1021
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
1022
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1023
    # Enabled - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1024
    @dbus_service_property(_interface, signature=u"b",
1025
                           access=u"readwrite")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1026
    def Enabled_dbus_property(self, value=None):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1027
        if value is None:       # get
1028
            return dbus.Boolean(self.enabled)
1029
        if value:
1030
            self.enable()
1031
        else:
1032
            self.disable()
1033
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1034
    # LastCheckedOK - property
237.2.144 by Teddy Hogeborn
Restore some poor D-Bus methods who got a bit hastily deleted. Enable
1035
    @dbus_service_property(_interface, signature=u"s",
1036
                           access=u"readwrite")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1037
    def LastCheckedOK_dbus_property(self, value=None):
237.2.144 by Teddy Hogeborn
Restore some poor D-Bus methods who got a bit hastily deleted. Enable
1038
        if value is not None:
1039
            self.checked_ok()
1040
            return
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1041
        if self.last_checked_ok is None:
1042
            return dbus.String(u"")
1043
        return dbus.String(self._datetime_to_dbus(self
1044
                                                  .last_checked_ok))
1045
    
237.2.205 by Teddy Hogeborn
* DBUS-API: Document new "LastApprovalRequest" client property.
1046
    # LastApprovalRequest - property
1047
    @dbus_service_property(_interface, signature=u"s", access=u"read")
1048
    def LastApprovalRequest_dbus_property(self):
1049
        if self.last_approval_request is None:
1050
            return dbus.String(u"")
1051
        return dbus.String(self.
1052
                           _datetime_to_dbus(self
1053
                                             .last_approval_request))
1054
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1055
    # Timeout - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1056
    @dbus_service_property(_interface, signature=u"t",
1057
                           access=u"readwrite")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1058
    def Timeout_dbus_property(self, value=None):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1059
        if value is None:       # get
1060
            return dbus.UInt64(self.timeout_milliseconds())
1061
        self.timeout = datetime.timedelta(0, 0, 0, value)
1062
        # Emit D-Bus signal
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1063
        self.PropertyChanged(dbus.String(u"Timeout"),
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1064
                             dbus.UInt64(value, variant_level=1))
1065
        if getattr(self, u"disable_initiator_tag", None) is None:
1066
            return
1067
        # Reschedule timeout
1068
        gobject.source_remove(self.disable_initiator_tag)
1069
        self.disable_initiator_tag = None
1070
        time_to_die = (self.
1071
                       _timedelta_to_milliseconds((self
1072
                                                   .last_checked_ok
1073
                                                   + self.timeout)
1074
                                                  - datetime.datetime
1075
                                                  .utcnow()))
1076
        if time_to_die <= 0:
1077
            # The timeout has passed
1078
            self.disable()
1079
        else:
1080
            self.disable_initiator_tag = (gobject.timeout_add
1081
                                          (time_to_die, self.disable))
1082
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1083
    # Interval - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1084
    @dbus_service_property(_interface, signature=u"t",
1085
                           access=u"readwrite")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1086
    def Interval_dbus_property(self, value=None):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1087
        if value is None:       # get
1088
            return dbus.UInt64(self.interval_milliseconds())
1089
        self.interval = datetime.timedelta(0, 0, 0, value)
1090
        # Emit D-Bus signal
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1091
        self.PropertyChanged(dbus.String(u"Interval"),
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1092
                             dbus.UInt64(value, variant_level=1))
1093
        if getattr(self, u"checker_initiator_tag", None) is None:
1094
            return
1095
        # Reschedule checker run
1096
        gobject.source_remove(self.checker_initiator_tag)
1097
        self.checker_initiator_tag = (gobject.timeout_add
1098
                                      (value, self.start_checker))
1099
        self.start_checker()    # Start one now, too
1100
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1101
    # Checker - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1102
    @dbus_service_property(_interface, signature=u"s",
1103
                           access=u"readwrite")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1104
    def Checker_dbus_property(self, value=None):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1105
        if value is None:       # get
1106
            return dbus.String(self.checker_command)
1107
        self.checker_command = value
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1108
        # Emit D-Bus signal
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1109
        self.PropertyChanged(dbus.String(u"Checker"),
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1110
                             dbus.String(self.checker_command,
1111
                                         variant_level=1))
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
1112
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1113
    # CheckerRunning - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1114
    @dbus_service_property(_interface, signature=u"b",
1115
                           access=u"readwrite")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1116
    def CheckerRunning_dbus_property(self, value=None):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1117
        if value is None:       # get
1118
            return dbus.Boolean(self.checker is not None)
1119
        if value:
1120
            self.start_checker()
1121
        else:
1122
            self.stop_checker()
1123
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1124
    # ObjectPath - property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1125
    @dbus_service_property(_interface, signature=u"o", access=u"read")
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1126
    def ObjectPath_dbus_property(self):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1127
        return self.dbus_object_path # is already a dbus.ObjectPath
1128
    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1129
    # Secret = property
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1130
    @dbus_service_property(_interface, signature=u"ay",
1131
                           access=u"write", byte_arrays=True)
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1132
    def Secret_dbus_property(self, value):
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1133
        self.secret = str(value)
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
1134
    
1135
    del _interface
3 by Björn Påhlsson
Python based server
1136
1137
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1138
class ProxyClient(object):
1139
    def __init__(self, child_pipe, fpr, address):
1140
        self._pipe = child_pipe
1141
        self._pipe.send(('init', fpr, address))
1142
        if not self._pipe.recv():
1143
            raise KeyError()
1144
1145
    def __getattribute__(self, name):
1146
        if(name == '_pipe'):
1147
            return super(ProxyClient, self).__getattribute__(name)
1148
        self._pipe.send(('getattr', name))
1149
        data = self._pipe.recv()
1150
        if data[0] == 'data':
1151
            return data[1]
1152
        if data[0] == 'function':
1153
            def func(*args, **kwargs):
1154
                self._pipe.send(('funcall', name, args, kwargs))
1155
                return self._pipe.recv()[1]
1156
            return func
1157
1158
    def __setattr__(self, name, value):
1159
        if(name == '_pipe'):
1160
            return super(ProxyClient, self).__setattr__(name, value)
1161
        self._pipe.send(('setattr', name, value))
1162
1163
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
1164
class ClientHandler(socketserver.BaseRequestHandler, object):
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1165
    """A class to handle client connections.
1166
    
1167
    Instantiated once for each connection to handle it.
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1168
    Note: This will run in its own forked process."""
12 by Teddy Hogeborn
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
1169
    
3 by Björn Påhlsson
Python based server
1170
    def handle(self):
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1171
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1172
            logger.info(u"TCP connection from: %s",
1173
                        unicode(self.client_address))
1174
            logger.debug(u"Pipe FD: %d",
1175
                         self.server.child_pipe.fileno())
1176
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1177
            session = (gnutls.connection
1178
                       .ClientSession(self.request,
1179
                                      gnutls.connection
1180
                                      .X509Credentials()))
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1181
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1182
            # Note: gnutls.connection.X509Credentials is really a
1183
            # generic GnuTLS certificate credentials object so long as
1184
            # no X.509 keys are added to it.  Therefore, we can use it
1185
            # here despite using OpenPGP certificates.
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1186
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1187
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1188
            #                      u"+AES-256-CBC", u"+SHA1",
1189
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
1190
            #                      u"+DHE-DSS"))
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1191
            # Use a fallback default, since this MUST be set.
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1192
            priority = self.server.gnutls_priority
1193
            if priority is None:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1194
                priority = u"NORMAL"
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1195
            (gnutls.library.functions
1196
             .gnutls_priority_set_direct(session._c_object,
1197
                                         priority, None))
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1198
237.5.2 by Teddy Hogeborn
* mandos (ClientHandler.handle): Set up the GnuTLS session object
1199
            # Start communication using the Mandos protocol
1200
            # Get protocol number
1201
            line = self.request.makefile().readline()
1202
            logger.debug(u"Protocol version: %r", line)
1203
            try:
1204
                if int(line.strip().split()[0]) > 1:
1205
                    raise RuntimeError
1206
            except (ValueError, IndexError, RuntimeError), error:
1207
                logger.error(u"Unknown protocol version: %s", error)
1208
                return
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1209
237.5.2 by Teddy Hogeborn
* mandos (ClientHandler.handle): Set up the GnuTLS session object
1210
            # Start GnuTLS connection
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1211
            try:
1212
                session.handshake()
1213
            except gnutls.errors.GNUTLSError, error:
1214
                logger.warning(u"Handshake failed: %s", error)
1215
                # Do not run session.bye() here: the session is not
1216
                # established.  Just abandon the request.
1217
                return
1218
            logger.debug(u"Handshake succeeded")
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1219
1220
            approval_required = False
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1221
            try:
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1222
                try:
1223
                    fpr = self.fingerprint(self.peer_certificate
1224
                                           (session))
1225
                except (TypeError, gnutls.errors.GNUTLSError), error:
1226
                    logger.warning(u"Bad certificate: %s", error)
1227
                    return
1228
                logger.debug(u"Fingerprint: %s", fpr)
1229
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1230
                try:
1231
                    client = ProxyClient(child_pipe, fpr,
1232
                                         self.client_address)
1233
                except KeyError:
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1234
                    return
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1235
                
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1236
                if client.approval_delay:
1237
                    delay = client.approval_delay
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1238
                    client.approvals_pending += 1
1239
                    approval_required = True
1240
                
24.1.148 by Björn Påhlsson
half working on-demand password and approved code
1241
                while True:
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1242
                    if not client.enabled:
1243
                        logger.warning(u"Client %s is disabled",
1244
                                       client.name)
1245
                        if self.server.use_dbus:
1246
                            # Emit D-Bus signal
1247
                            client.Rejected("Disabled")                    
1248
                        return
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1249
                    
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1250
                    if client._approved or not client.approval_delay:
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1251
                        #We are approved or approval is disabled
1252
                        break
1253
                    elif client._approved is None:
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1254
                        logger.info(u"Client %s needs approval",
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1255
                                    client.name)
1256
                        if self.server.use_dbus:
1257
                            # Emit D-Bus signal
1258
                            client.NeedApproval(
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1259
                                client.approval_delay_milliseconds(),
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1260
                                client.approved_by_default)
1261
                    else:
1262
                        logger.warning(u"Client %s was not approved",
1263
                                       client.name)
1264
                        if self.server.use_dbus:
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1265
                            # Emit D-Bus signal
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1266
                            client.Rejected("Denied")
24.1.148 by Björn Påhlsson
half working on-demand password and approved code
1267
                        return
1268
                    
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1269
                    #wait until timeout or approved
1270
                    #x = float(client._timedelta_to_milliseconds(delay))
1271
                    time = datetime.datetime.now()
1272
                    client.changedstate.acquire()
1273
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1274
                    client.changedstate.release()
1275
                    time2 = datetime.datetime.now()
1276
                    if (time2 - time) >= delay:
1277
                        if not client.approved_by_default:
1278
                            logger.warning("Client %s timed out while"
1279
                                           " waiting for approval",
1280
                                           client.name)
1281
                            if self.server.use_dbus:
1282
                                # Emit D-Bus signal
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
1283
                                client.Rejected("Approval timed out")
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1284
                            return
1285
                        else:
1286
                            break
1287
                    else:
1288
                        delay -= time2 - time
1289
                
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1290
                sent_size = 0
1291
                while sent_size < len(client.secret):
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1292
                    try:
1293
                        sent = session.send(client.secret[sent_size:])
1294
                    except (gnutls.errors.GNUTLSError), error:
1295
                        logger.warning("gnutls send failed")
1296
                        return
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1297
                    logger.debug(u"Sent: %d, remaining: %d",
1298
                                 sent, len(client.secret)
1299
                                 - (sent_size + sent))
1300
                    sent_size += sent
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1301
1302
                logger.info(u"Sending secret to %s", client.name)
1303
                # bump the timeout as if seen
1304
                client.checked_ok()
1305
                if self.server.use_dbus:
1306
                    # Emit D-Bus signal
1307
                    client.GotSecret()
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1308
            
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1309
            finally:
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1310
                if approval_required:
1311
                    client.approvals_pending -= 1
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1312
                try:
1313
                    session.bye()
1314
                except (gnutls.errors.GNUTLSError), error:
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1315
                    logger.warning("GnuTLS bye failed")
237.2.93 by Teddy Hogeborn
* mandos (peer_certificate, fingerprint): Moved into "TCP_handler"
1316
    
1317
    @staticmethod
1318
    def peer_certificate(session):
1319
        "Return the peer's OpenPGP certificate as a bytestring"
1320
        # If not an OpenPGP certificate...
1321
        if (gnutls.library.functions
1322
            .gnutls_certificate_type_get(session._c_object)
1323
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1324
            # ...do the normal thing
1325
            return session.peer_certificate
1326
        list_size = ctypes.c_uint(1)
1327
        cert_list = (gnutls.library.functions
1328
                     .gnutls_certificate_get_peers
1329
                     (session._c_object, ctypes.byref(list_size)))
1330
        if not bool(cert_list) and list_size.value != 0:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1331
            raise gnutls.errors.GNUTLSError(u"error getting peer"
1332
                                            u" certificate")
237.2.93 by Teddy Hogeborn
* mandos (peer_certificate, fingerprint): Moved into "TCP_handler"
1333
        if list_size.value == 0:
1334
            return None
1335
        cert = cert_list[0]
1336
        return ctypes.string_at(cert.data, cert.size)
1337
    
1338
    @staticmethod
1339
    def fingerprint(openpgp):
1340
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1341
        # New GnuTLS "datum" with the OpenPGP public key
1342
        datum = (gnutls.library.types
1343
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1344
                                             ctypes.POINTER
1345
                                             (ctypes.c_ubyte)),
1346
                                 ctypes.c_uint(len(openpgp))))
1347
        # New empty GnuTLS certificate
1348
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1349
        (gnutls.library.functions
1350
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
1351
        # Import the OpenPGP public key into the certificate
1352
        (gnutls.library.functions
1353
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1354
                                    gnutls.library.constants
1355
                                    .GNUTLS_OPENPGP_FMT_RAW))
1356
        # Verify the self signature in the key
1357
        crtverify = ctypes.c_uint()
1358
        (gnutls.library.functions
1359
         .gnutls_openpgp_crt_verify_self(crt, 0,
1360
                                         ctypes.byref(crtverify)))
1361
        if crtverify.value != 0:
1362
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1363
            raise (gnutls.errors.CertificateSecurityError
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1364
                   (u"Verify failed"))
237.2.93 by Teddy Hogeborn
* mandos (peer_certificate, fingerprint): Moved into "TCP_handler"
1365
        # New buffer for the fingerprint
1366
        buf = ctypes.create_string_buffer(20)
1367
        buf_len = ctypes.c_size_t()
1368
        # Get the fingerprint from the certificate into the buffer
1369
        (gnutls.library.functions
1370
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1371
                                             ctypes.byref(buf_len)))
1372
        # Deinit the certificate
1373
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1374
        # Convert the buffer to a Python bytestring
1375
        fpr = ctypes.string_at(buf, buf_len.value)
1376
        # Convert the bytestring to hexadecimal notation
1377
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1378
        return hex_fpr
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1379
1380
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1381
class MultiprocessingMixIn(object):
1382
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1383
    def sub_process_main(self, request, address):
1384
        try:
1385
            self.finish_request(request, address)
1386
        except:
1387
            self.handle_error(request, address)
1388
        self.close_request(request)
1389
            
1390
    def process_request(self, request, address):
1391
        """Start a new process to process the request."""
1392
        multiprocessing.Process(target = self.sub_process_main,
1393
                                args = (request, address)).start()
1394
1395
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1396
    """ adds a pipe to the MixIn """
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1397
    def process_request(self, request, client_address):
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1398
        """Overrides and wraps the original process_request().
1399
        
237.2.118 by Teddy Hogeborn
* mandos: White-space fixes only.
1400
        This function creates a new pipe in self.pipe
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1401
        """
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1402
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1403
1404
        super(MultiprocessingMixInWithPipe,
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1405
              self).process_request(request, client_address)
24.1.152 by Björn Påhlsson
bug fixes that prevent problems when runing server as root
1406
        self.child_pipe.close()
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1407
        self.add_pipe(parent_pipe)
24.1.154 by Björn Påhlsson
merge
1408
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1409
    def add_pipe(self, parent_pipe):
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1410
        """Dummy function; override as necessary"""
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1411
        pass
1412
1413
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
1414
                     socketserver.TCPServer, object):
250 by Teddy Hogeborn
Merge from trunk. Notable changes:
1415
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1416
    
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1417
    Attributes:
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1418
        enabled:        Boolean; whether this server is activated yet
1419
        interface:      None or a network interface name (string)
1420
        use_ipv6:       Boolean; to use IPv6 or not
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1421
    """
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1422
    def __init__(self, server_address, RequestHandlerClass,
237.2.102 by Teddy Hogeborn
Code cleanup.
1423
                 interface=None, use_ipv6=True):
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1424
        self.interface = interface
1425
        if use_ipv6:
1426
            self.address_family = socket.AF_INET6
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
1427
        socketserver.TCPServer.__init__(self, server_address,
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1428
                                        RequestHandlerClass)
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1429
    def server_bind(self):
1430
        """This overrides the normal server_bind() function
1431
        to bind to an interface if one was specified, and also NOT to
1432
        bind to an address or port if they were not specified."""
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1433
        if self.interface is not None:
237.2.101 by Teddy Hogeborn
* mandos: Minor doc string fixes.
1434
            if SO_BINDTODEVICE is None:
1435
                logger.error(u"SO_BINDTODEVICE does not exist;"
1436
                             u" cannot bind to interface %s",
1437
                             self.interface)
1438
            else:
1439
                try:
1440
                    self.socket.setsockopt(socket.SOL_SOCKET,
1441
                                           SO_BINDTODEVICE,
1442
                                           str(self.interface
1443
                                               + u'\0'))
1444
                except socket.error, error:
1445
                    if error[0] == errno.EPERM:
1446
                        logger.error(u"No permission to"
1447
                                     u" bind to interface %s",
1448
                                     self.interface)
1449
                    elif error[0] == errno.ENOPROTOOPT:
1450
                        logger.error(u"SO_BINDTODEVICE not available;"
1451
                                     u" cannot bind to interface %s",
1452
                                     self.interface)
1453
                    else:
1454
                        raise
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1455
        # Only bind(2) the socket if we really need to.
1456
        if self.server_address[0] or self.server_address[1]:
1457
            if not self.server_address[0]:
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
1458
                if self.address_family == socket.AF_INET6:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1459
                    any_address = u"::" # in6addr_any
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
1460
                else:
1461
                    any_address = socket.INADDR_ANY
1462
                self.server_address = (any_address,
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1463
                                       self.server_address[1])
49 by Teddy Hogeborn
* mandos (IPv6_TCPServer.server_bind): Bug fix: allow port to be empty
1464
            elif not self.server_address[1]:
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1465
                self.server_address = (self.server_address[0],
1466
                                       0)
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1467
#                 if self.interface:
49 by Teddy Hogeborn
* mandos (IPv6_TCPServer.server_bind): Bug fix: allow port to be empty
1468
#                     self.server_address = (self.server_address[0],
1469
#                                            0, # port
1470
#                                            0, # flowinfo
1471
#                                            if_nametoindex
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1472
#                                            (self.interface))
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
1473
            return socketserver.TCPServer.server_bind(self)
237.2.102 by Teddy Hogeborn
Code cleanup.
1474
1475
1476
class MandosServer(IPv6_TCPServer):
1477
    """Mandos server.
1478
    
1479
    Attributes:
1480
        clients:        set of Client objects
1481
        gnutls_priority GnuTLS priority string
1482
        use_dbus:       Boolean; to emit D-Bus signals or not
237.2.103 by Teddy Hogeborn
Code cleanup.
1483
    
1484
    Assumes a gobject.MainLoop event loop.
237.2.102 by Teddy Hogeborn
Code cleanup.
1485
    """
1486
    def __init__(self, server_address, RequestHandlerClass,
1487
                 interface=None, use_ipv6=True, clients=None,
1488
                 gnutls_priority=None, use_dbus=True):
1489
        self.enabled = False
1490
        self.clients = clients
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
1491
        if self.clients is None:
1492
            self.clients = set()
237.2.102 by Teddy Hogeborn
Code cleanup.
1493
        self.use_dbus = use_dbus
1494
        self.gnutls_priority = gnutls_priority
1495
        IPv6_TCPServer.__init__(self, server_address,
1496
                                RequestHandlerClass,
1497
                                interface = interface,
1498
                                use_ipv6 = use_ipv6)
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
1499
    def server_activate(self):
1500
        if self.enabled:
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
1501
            return socketserver.TCPServer.server_activate(self)
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
1502
    def enable(self):
1503
        self.enabled = True
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1504
    def add_pipe(self, parent_pipe):
237.2.103 by Teddy Hogeborn
Code cleanup.
1505
        # Call "handle_ipc" for both data and EOF events
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1506
        gobject.io_add_watch(parent_pipe.fileno(),
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1507
                             gobject.IO_IN | gobject.IO_HUP,
1508
                             functools.partial(self.handle_ipc,
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1509
                                               parent_pipe = parent_pipe))
1510
        
1511
    def handle_ipc(self, source, condition, parent_pipe=None,
1512
                   client_object=None):
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1513
        condition_names = {
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1514
            gobject.IO_IN: u"IN",   # There is data to read.
1515
            gobject.IO_OUT: u"OUT", # Data can be written (without
1516
                                    # blocking).
1517
            gobject.IO_PRI: u"PRI", # There is urgent data to read.
1518
            gobject.IO_ERR: u"ERR", # Error condition.
1519
            gobject.IO_HUP: u"HUP"  # Hung up (the connection has been
1520
                                    # broken, usually for pipes and
1521
                                    # sockets).
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1522
            }
1523
        conditions_string = ' | '.join(name
1524
                                       for cond, name in
1525
                                       condition_names.iteritems()
1526
                                       if cond & condition)
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1527
        # error or the other end of multiprocessing.Pipe has closed
1528
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
24.1.152 by Björn Påhlsson
bug fixes that prevent problems when runing server as root
1529
            return False
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1530
        
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1531
        # Read a request from the child
1532
        request = parent_pipe.recv()
1533
        command = request[0]
1534
        
1535
        if command == 'init':
1536
            fpr = request[1]
1537
            address = request[2]
1538
            
1539
            for c in self.clients:
1540
                if c.fingerprint == fpr:
1541
                    client = c
1542
                    break
1543
            else:
1544
                logger.warning(u"Client not found for fingerprint: %s, ad"
1545
                               u"dress: %s", fpr, address)
1546
                if self.use_dbus:
1547
                    # Emit D-Bus signal
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
1548
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1549
                parent_pipe.send(False)
1550
                return False
1551
            
1552
            gobject.io_add_watch(parent_pipe.fileno(),
1553
                                 gobject.IO_IN | gobject.IO_HUP,
1554
                                 functools.partial(self.handle_ipc,
1555
                                                   parent_pipe = parent_pipe,
1556
                                                   client_object = client))
1557
            parent_pipe.send(True)
1558
            # remove the old hook in favor of the new above hook on same fileno
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1559
            return False
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1560
        if command == 'funcall':
1561
            funcname = request[1]
1562
            args = request[2]
1563
            kwargs = request[3]
1564
            
1565
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1566
1567
        if command == 'getattr':
1568
            attrname = request[1]
1569
            if callable(client_object.__getattribute__(attrname)):
1570
                parent_pipe.send(('function',))
1571
            else:
1572
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
24.2.4 by teddy at bsnet
* mandos (ClientDBus.approvals_pending): Changed to be a property
1573
        
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1574
        if command == 'setattr':
1575
            attrname = request[1]
1576
            value = request[2]
1577
            setattr(client_object, attrname, value)
24.1.154 by Björn Påhlsson
merge
1578
237.4.1 by Teddy Hogeborn
Start of new pipe-based IPC mechanism.
1579
        return True
10 by Teddy Hogeborn
* server.py: Bug fix: Do "from __future__ import division".
1580
3 by Björn Påhlsson
Python based server
1581
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
1582
def string_to_delta(interval):
1583
    """Parse a string and return a datetime.timedelta
237.2.53 by Teddy Hogeborn
* mandos (main): Bug fix: Do setgid before setuid. Add verbose GnuTLS
1584
    
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1585
    >>> string_to_delta(u'7d')
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
1586
    datetime.timedelta(7)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1587
    >>> string_to_delta(u'60s')
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
1588
    datetime.timedelta(0, 60)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1589
    >>> string_to_delta(u'60m')
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
1590
    datetime.timedelta(0, 3600)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1591
    >>> string_to_delta(u'24h')
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
1592
    datetime.timedelta(1)
1593
    >>> string_to_delta(u'1w')
1594
    datetime.timedelta(7)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1595
    >>> string_to_delta(u'5m 30s')
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
1596
    datetime.timedelta(0, 330)
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
1597
    """
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
1598
    timevalue = datetime.timedelta(0)
1599
    for s in interval.split():
1600
        try:
215 by Teddy Hogeborn
* mandos: Remove unused "select" module. Import "ctypes.util".
1601
            suffix = unicode(s[-1])
1602
            value = int(s[:-1])
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
1603
            if suffix == u"d":
1604
                delta = datetime.timedelta(value)
1605
            elif suffix == u"s":
1606
                delta = datetime.timedelta(0, value)
1607
            elif suffix == u"m":
1608
                delta = datetime.timedelta(0, 0, 0, 0, value)
1609
            elif suffix == u"h":
1610
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1611
            elif suffix == u"w":
1612
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1613
            else:
237.2.163 by Teddy Hogeborn
* mandos (Client.enable): Bug fix: Start new immediate checker last to
1614
                raise ValueError(u"Unknown suffix %r" % suffix)
1615
        except (ValueError, IndexError), e:
1616
            raise ValueError(e.message)
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
1617
        timevalue += delta
1618
    return timevalue
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
1619
8 by Teddy Hogeborn
* Makefile (client_debug): Bug fix; add quotes and / to CERT_ROOT.
1620
24.1.13 by Björn Påhlsson
mandosclient
1621
def if_nametoindex(interface):
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1622
    """Call the C function if_nametoindex(), or equivalent
1623
    
1624
    Note: This function cannot accept a unicode string."""
24.1.13 by Björn Påhlsson
mandosclient
1625
    global if_nametoindex
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1626
    try:
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
1627
        if_nametoindex = (ctypes.cdll.LoadLibrary
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1628
                          (ctypes.util.find_library(u"c"))
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
1629
                          .if_nametoindex)
12 by Teddy Hogeborn
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
1630
    except (OSError, AttributeError):
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1631
        logger.warning(u"Doing if_nametoindex the hard way")
24.1.13 by Björn Påhlsson
mandosclient
1632
        def if_nametoindex(interface):
28 by Teddy Hogeborn
* server.conf: New file.
1633
            "Get an interface index the hard way, i.e. using fcntl()"
1634
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1635
            with contextlib.closing(socket.socket()) as s:
237 by Teddy Hogeborn
* mandos: Also import "with_statement" and "absolute_import" from
1636
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1637
                                    struct.pack(str(u"16s16x"),
1638
                                                interface))
1639
            interface_index = struct.unpack(str(u"I"),
1640
                                            ifreq[16:20])[0]
28 by Teddy Hogeborn
* server.conf: New file.
1641
            return interface_index
24.1.13 by Björn Påhlsson
mandosclient
1642
    return if_nametoindex(interface)
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1643
1644
47 by Teddy Hogeborn
* plugbasedclient.c: Renamed to "mandos-client.c". All users changed.
1645
def daemon(nochdir = False, noclose = False):
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
1646
    """See daemon(3).  Standard BSD Unix function.
237.2.94 by Teddy Hogeborn
Minor code cleanup, and a bug fix.
1647
    
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
1648
    This should really exist as os.daemon, but it doesn't (yet)."""
1649
    if os.fork():
1650
        sys.exit()
1651
    os.setsid()
1652
    if not nochdir:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1653
        os.chdir(u"/")
46 by Teddy Hogeborn
* network-protocol.txt: New.
1654
    if os.fork():
1655
        sys.exit()
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
1656
    if not noclose:
1657
        # Close all standard open file descriptors
28 by Teddy Hogeborn
* server.conf: New file.
1658
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
1659
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1660
            raise OSError(errno.ENODEV,
237.2.151 by Teddy Hogeborn
* mandos (daemon): Use "os.path.devnull" in the error message.
1661
                          u"%s not a character device"
1662
                          % os.path.devnull)
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
1663
        os.dup2(null, sys.stdin.fileno())
1664
        os.dup2(null, sys.stdout.fileno())
1665
        os.dup2(null, sys.stderr.fileno())
1666
        if null > 2:
1667
            os.close(null)
1668
1669
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
1670
def main():
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1671
    
237.2.142 by Teddy Hogeborn
* mandos: Fix line lengths.
1672
    ##################################################################
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1673
    # Parsing of options, both command line and config file
1674
    
238 by Teddy Hogeborn
Merge from trunk, but disable the unfinished D-Bus feature:
1675
    parser = optparse.OptionParser(version = "%%prog %s" % version)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1676
    parser.add_option("-i", u"--interface", type=u"string",
1677
                      metavar="IF", help=u"Bind to interface IF")
1678
    parser.add_option("-a", u"--address", type=u"string",
1679
                      help=u"Address to listen for requests on")
1680
    parser.add_option("-p", u"--port", type=u"int",
1681
                      help=u"Port number to receive requests on")
1682
    parser.add_option("--check", action=u"store_true",
1683
                      help=u"Run self-test")
1684
    parser.add_option("--debug", action=u"store_true",
1685
                      help=u"Debug mode; run in foreground and log to"
1686
                      u" terminal")
237.2.210 by teddy at bsnet
* mandos: Fixed "--help" output.
1687
    parser.add_option("--debuglevel", type=u"string", metavar="LEVEL",
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1688
                      help=u"Debug level for stdout output")
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1689
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1690
                      u" priority string (see GnuTLS documentation)")
1691
    parser.add_option("--servicename", type=u"string",
1692
                      metavar=u"NAME", help=u"Zeroconf service name")
1693
    parser.add_option("--configdir", type=u"string",
1694
                      default=u"/etc/mandos", metavar=u"DIR",
1695
                      help=u"Directory to search for configuration"
1696
                      u" files")
1697
    parser.add_option("--no-dbus", action=u"store_false",
1698
                      dest=u"use_dbus", help=u"Do not provide D-Bus"
1699
                      u" system bus interface")
1700
    parser.add_option("--no-ipv6", action=u"store_false",
1701
                      dest=u"use_ipv6", help=u"Do not use IPv6")
215 by Teddy Hogeborn
* mandos: Remove unused "select" module. Import "ctypes.util".
1702
    options = parser.parse_args()[0]
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1703
    
4 by Teddy Hogeborn
* server.py (Client.created, Client.next_check): New.
1704
    if options.check:
1705
        import doctest
1706
        doctest.testmod()
1707
        sys.exit()
3 by Björn Påhlsson
Python based server
1708
    
28 by Teddy Hogeborn
* server.conf: New file.
1709
    # Default values for config file for server-global settings
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1710
    server_defaults = { u"interface": u"",
1711
                        u"address": u"",
1712
                        u"port": u"",
1713
                        u"debug": u"False",
1714
                        u"priority":
1715
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1716
                        u"servicename": u"Mandos",
1717
                        u"use_dbus": u"True",
1718
                        u"use_ipv6": u"True",
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1719
                        u"debuglevel": u"",
28 by Teddy Hogeborn
* server.conf: New file.
1720
                        }
1721
    
1722
    # Parse config file for server-global settings
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
1723
    server_config = configparser.SafeConfigParser(server_defaults)
28 by Teddy Hogeborn
* server.conf: New file.
1724
    del server_defaults
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1725
    server_config.read(os.path.join(options.configdir,
1726
                                    u"mandos.conf"))
28 by Teddy Hogeborn
* server.conf: New file.
1727
    # Convert the SafeConfigParser object to a dict
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
1728
    server_settings = server_config.defaults()
237.2.45 by Teddy Hogeborn
* mandos (main): Bug fix: use "getint" on the "port" config file
1729
    # Use the appropriate methods on the non-string config options
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1730
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
1731
        server_settings[option] = server_config.getboolean(u"DEFAULT",
1732
                                                           option)
237.2.45 by Teddy Hogeborn
* mandos (main): Bug fix: use "getint" on the "port" config file
1733
    if server_settings["port"]:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1734
        server_settings["port"] = server_config.getint(u"DEFAULT",
1735
                                                       u"port")
28 by Teddy Hogeborn
* server.conf: New file.
1736
    del server_config
1737
    
1738
    # Override the settings from the config file with command line
1739
    # options, if set.
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1740
    for option in (u"interface", u"address", u"port", u"debug",
1741
                   u"priority", u"servicename", u"configdir",
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1742
                   u"use_dbus", u"use_ipv6", u"debuglevel"):
28 by Teddy Hogeborn
* server.conf: New file.
1743
        value = getattr(options, option)
1744
        if value is not None:
1745
            server_settings[option] = value
1746
    del options
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1747
    # Force all strings to be unicode
1748
    for option in server_settings.keys():
1749
        if type(server_settings[option]) is str:
1750
            server_settings[option] = unicode(server_settings[option])
28 by Teddy Hogeborn
* server.conf: New file.
1751
    # Now we have our good server settings in "server_settings"
1752
    
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1753
    ##################################################################
1754
    
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1755
    # For convenience
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1756
    debug = server_settings[u"debug"]
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1757
    debuglevel = server_settings[u"debuglevel"]
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1758
    use_dbus = server_settings[u"use_dbus"]
1759
    use_ipv6 = server_settings[u"use_ipv6"]
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1760
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1761
    if server_settings[u"servicename"] != u"Mandos":
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
1762
        syslogger.setFormatter(logging.Formatter
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1763
                               (u'Mandos (%s) [%%(process)d]:'
1764
                                u' %%(levelname)s: %%(message)s'
1765
                                % server_settings[u"servicename"]))
52 by Teddy Hogeborn
* mandos: Make syslog use "/dev/log" instead of UDP to localhost.
1766
    
28 by Teddy Hogeborn
* server.conf: New file.
1767
    # Parse config file with clients
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1768
    client_defaults = { u"timeout": u"1h",
1769
                        u"interval": u"5m",
1770
                        u"checker": u"fping -q -- %%(host)s",
1771
                        u"host": u"",
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1772
                        u"approval_delay": u"0s",
1773
                        u"approval_duration": u"1s",
28 by Teddy Hogeborn
* server.conf: New file.
1774
                        }
237.2.98 by Teddy Hogeborn
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
1775
    client_config = configparser.SafeConfigParser(client_defaults)
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1776
    client_config.read(os.path.join(server_settings[u"configdir"],
1777
                                    u"clients.conf"))
1778
    
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1779
    global mandos_dbus_service
1780
    mandos_dbus_service = None
28 by Teddy Hogeborn
* server.conf: New file.
1781
    
237.2.102 by Teddy Hogeborn
Code cleanup.
1782
    tcp_server = MandosServer((server_settings[u"address"],
1783
                               server_settings[u"port"]),
1784
                              ClientHandler,
269.1.3 by teddy at bsnet
* mandos (main): Bug fix: Don't try to bind to an empty string
1785
                              interface=(server_settings[u"interface"]
1786
                                         or None),
237.2.102 by Teddy Hogeborn
Code cleanup.
1787
                              use_ipv6=use_ipv6,
1788
                              gnutls_priority=
1789
                              server_settings[u"priority"],
1790
                              use_dbus=use_dbus)
237.2.202 by Teddy Hogeborn
* mandos: Do not write pid file if --debug is passed.
1791
    if not debug:
1792
        pidfilename = u"/var/run/mandos.pid"
1793
        try:
1794
            pidfile = open(pidfilename, u"w")
1795
        except IOError:
1796
            logger.error(u"Could not open file %r", pidfilename)
164 by Teddy Hogeborn
* mandos: Open the PID file before daemonizing, but write to it
1797
    
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
1798
    try:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1799
        uid = pwd.getpwnam(u"_mandos").pw_uid
1800
        gid = pwd.getpwnam(u"_mandos").pw_gid
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
1801
    except KeyError:
1802
        try:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1803
            uid = pwd.getpwnam(u"mandos").pw_uid
1804
            gid = pwd.getpwnam(u"mandos").pw_gid
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
1805
        except KeyError:
1806
            try:
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1807
                uid = pwd.getpwnam(u"nobody").pw_uid
1808
                gid = pwd.getpwnam(u"nobody").pw_gid
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
1809
            except KeyError:
1810
                uid = 65534
1811
                gid = 65534
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
1812
    try:
237.2.53 by Teddy Hogeborn
* mandos (main): Bug fix: Do setgid before setuid. Add verbose GnuTLS
1813
        os.setgid(gid)
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
1814
        os.setuid(uid)
1815
    except OSError, error:
1816
        if error[0] != errno.EPERM:
1817
            raise error
164 by Teddy Hogeborn
* mandos: Open the PID file before daemonizing, but write to it
1818
    
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1819
    if not debug and not debuglevel:
1820
        syslogger.setLevel(logging.WARNING)
1821
        console.setLevel(logging.WARNING)
1822
    if debuglevel:
1823
        level = getattr(logging, debuglevel.upper())
1824
        syslogger.setLevel(level)
1825
        console.setLevel(level)
1826
237.2.53 by Teddy Hogeborn
* mandos (main): Bug fix: Do setgid before setuid. Add verbose GnuTLS
1827
    if debug:
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1828
        # Enable all possible GnuTLS debugging
1829
        
237.2.53 by Teddy Hogeborn
* mandos (main): Bug fix: Do setgid before setuid. Add verbose GnuTLS
1830
        # "Use a log level over 10 to enable all debugging options."
1831
        # - GnuTLS manual
1832
        gnutls.library.functions.gnutls_global_set_log_level(11)
1833
        
1834
        @gnutls.library.types.gnutls_log_func
1835
        def debug_gnutls(level, string):
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1836
            logger.debug(u"GnuTLS: %s", string[:-1])
237.2.53 by Teddy Hogeborn
* mandos (main): Bug fix: Do setgid before setuid. Add verbose GnuTLS
1837
        
1838
        (gnutls.library.functions
1839
         .gnutls_global_set_log_function(debug_gnutls))
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1840
        
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1841
        # Redirect stdin so all checkers get /dev/null
1842
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1843
        os.dup2(null, sys.stdin.fileno())
1844
        if null > 2:
1845
            os.close(null)
1846
    else:
1847
        # No console logging
1848
        logger.removeHandler(console)
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
1849
    
237.2.53 by Teddy Hogeborn
* mandos (main): Bug fix: Do setgid before setuid. Add verbose GnuTLS
1850
    
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
1851
    global main_loop
1852
    # From the Avahi example code
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1853
    DBusGMainLoop(set_as_default=True )
1854
    main_loop = gobject.MainLoop()
1855
    bus = dbus.SystemBus()
1856
    # End of Avahi example code
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1857
    if use_dbus:
237.2.165 by Teddy Hogeborn
* mandos (Client.disable): Rename keyword argument "log" to "quiet",
1858
        try:
1859
            bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1860
                                            bus, do_not_queue=True)
1861
        except dbus.exceptions.NameExistsException, e:
1862
            logger.error(unicode(e) + u", disabling D-Bus")
1863
            use_dbus = False
1864
            server_settings[u"use_dbus"] = False
1865
            tcp_server.use_dbus = False
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
1866
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1867
    service = AvahiService(name = server_settings[u"servicename"],
1868
                           servicetype = u"_mandos._tcp",
1869
                           protocol = protocol, bus = bus)
1870
    if server_settings["interface"]:
1871
        service.interface = (if_nametoindex
1872
                             (str(server_settings[u"interface"])))
24.1.152 by Björn Påhlsson
bug fixes that prevent problems when runing server as root
1873
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1874
    if not debug:
1875
        # Close all input and output, do double fork, etc.
1876
        daemon()
1877
        
24.1.152 by Björn Påhlsson
bug fixes that prevent problems when runing server as root
1878
    global multiprocessing_manager
1879
    multiprocessing_manager = multiprocessing.Manager()
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
1880
    
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
1881
    client_class = Client
1882
    if use_dbus:
237.2.100 by Teddy Hogeborn
Code cleanup. Move some global stuff into main.
1883
        client_class = functools.partial(ClientDBus, bus = bus)
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1884
    def client_config_items(config, section):
1885
        special_settings = {
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1886
            "approved_by_default":
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1887
                lambda: config.getboolean(section,
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1888
                                          "approved_by_default"),
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1889
            }
1890
        for name, value in config.items(section):
1891
            try:
24.1.150 by Björn Påhlsson
* mandos: Added ClientDBus.approve_pending property. Exposed
1892
                yield (name, special_settings[name]())
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1893
            except KeyError:
1894
                yield (name, value)
1895
    
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
1896
    tcp_server.clients.update(set(
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
1897
            client_class(name = section,
24.1.149 by Björn Påhlsson
Changed ForkingMixIn in favor of multiprocessing
1898
                         config= dict(client_config_items(
1899
                        client_config, section)))
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
1900
            for section in client_config.sections()))
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
1901
    if not tcp_server.clients:
237.2.7 by Teddy Hogeborn
* debian/control (Build-Depends): Bug fix: Added "docbook-xml".
1902
        logger.warning(u"No clients defined")
24.1.155 by Björn Påhlsson
mandos server: Added debuglevel that adjust at what level information
1903
        
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
1904
    if not debug:
237.2.202 by Teddy Hogeborn
* mandos: Do not write pid file if --debug is passed.
1905
        try:
1906
            with pidfile:
1907
                pid = os.getpid()
1908
                pidfile.write(str(pid) + "\n")
1909
            del pidfile
1910
        except IOError:
1911
            logger.error(u"Could not write to file %r with PID %d",
1912
                         pidfilename, pid)
1913
        except NameError:
1914
            # "pidfile" was never created
1915
            pass
1916
        del pidfilename
1917
        
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
1918
        signal.signal(signal.SIGINT, signal.SIG_IGN)
237.2.202 by Teddy Hogeborn
* mandos: Do not write pid file if --debug is passed.
1919
28 by Teddy Hogeborn
* server.conf: New file.
1920
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1921
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
1922
    
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1923
    if use_dbus:
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1924
        class MandosDBusService(dbus.service.Object):
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1925
            """A D-Bus proxy object"""
1926
            def __init__(self):
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1927
                dbus.service.Object.__init__(self, bus, u"/")
237.2.42 by Teddy Hogeborn
* mandos (Client.__init__): Disable D-Bus during init to avoid
1928
            _interface = u"se.bsnet.fukt.Mandos"
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1929
            
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1930
            @dbus.service.signal(_interface, signature=u"o")
1931
            def ClientAdded(self, objpath):
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1932
                "D-Bus signal"
1933
                pass
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1934
            
237.2.172 by Teddy Hogeborn
* mandos (MandosServer.handle_ipc): Better log message.
1935
            @dbus.service.signal(_interface, signature=u"ss")
1936
            def ClientNotFound(self, fingerprint, address):
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1937
                "D-Bus signal"
1938
                pass
1939
            
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1940
            @dbus.service.signal(_interface, signature=u"os")
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1941
            def ClientRemoved(self, objpath, name):
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1942
                "D-Bus signal"
1943
                pass
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1944
            
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1945
            @dbus.service.method(_interface, out_signature=u"ao")
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1946
            def GetAllClients(self):
237.2.46 by Teddy Hogeborn
* mandos (peer_certificate): Handle NULL pointer from
1947
                "D-Bus method"
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
1948
                return dbus.Array(c.dbus_object_path
1949
                                  for c in tcp_server.clients)
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1950
            
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1951
            @dbus.service.method(_interface,
1952
                                 out_signature=u"a{oa{sv}}")
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1953
            def GetAllClientsWithProperties(self):
237.2.46 by Teddy Hogeborn
* mandos (peer_certificate): Handle NULL pointer from
1954
                "D-Bus method"
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1955
                return dbus.Dictionary(
237.2.143 by Teddy Hogeborn
Use D-Bus properties instead of our own methods.
1956
                    ((c.dbus_object_path, c.GetAll(u""))
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
1957
                     for c in tcp_server.clients),
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1958
                    signature=u"oa{sv}")
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1959
            
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
1960
            @dbus.service.method(_interface, in_signature=u"o")
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1961
            def RemoveClient(self, object_path):
237.2.46 by Teddy Hogeborn
* mandos (peer_certificate): Handle NULL pointer from
1962
                "D-Bus method"
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
1963
                for c in tcp_server.clients:
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1964
                    if c.dbus_object_path == object_path:
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
1965
                        tcp_server.clients.remove(c)
237.2.91 by Teddy Hogeborn
* mandos (Client): Move all D-Bus code to new "ClientDBus" class.
1966
                        c.remove_from_connection()
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1967
                        # Don't signal anything except ClientRemoved
237.2.165 by Teddy Hogeborn
* mandos (Client.disable): Rename keyword argument "log" to "quiet",
1968
                        c.disable(quiet=True)
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1969
                        # Emit D-Bus signal
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1970
                        self.ClientRemoved(object_path, c.name)
1971
                        return
237.2.163 by Teddy Hogeborn
* mandos (Client.enable): Bug fix: Start new immediate checker last to
1972
                raise KeyError(object_path)
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1973
            
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1974
            del _interface
237.2.41 by Teddy Hogeborn
* mandos (Client.GetAllProperties): Also send Client.dbus_object_path
1975
        
237.2.90 by Teddy Hogeborn
Merge from pipe IPC branch.
1976
        mandos_dbus_service = MandosDBusService()
237.2.1 by Teddy Hogeborn
First version of a somewhat complete D-Bus server interface. Also
1977
    
237.2.163 by Teddy Hogeborn
* mandos (Client.enable): Bug fix: Start new immediate checker last to
1978
    def cleanup():
1979
        "Cleanup function; run on exit"
1980
        service.cleanup()
1981
        
1982
        while tcp_server.clients:
1983
            client = tcp_server.clients.pop()
237.2.165 by Teddy Hogeborn
* mandos (Client.disable): Rename keyword argument "log" to "quiet",
1984
            if use_dbus:
1985
                client.remove_from_connection()
237.2.163 by Teddy Hogeborn
* mandos (Client.enable): Bug fix: Start new immediate checker last to
1986
            client.disable_hook = None
1987
            # Don't signal anything except ClientRemoved
237.2.165 by Teddy Hogeborn
* mandos (Client.disable): Rename keyword argument "log" to "quiet",
1988
            client.disable(quiet=True)
237.2.163 by Teddy Hogeborn
* mandos (Client.enable): Bug fix: Start new immediate checker last to
1989
            if use_dbus:
1990
                # Emit D-Bus signal
1991
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1992
                                                  client.name)
1993
    
1994
    atexit.register(cleanup)
1995
    
237.2.104 by Teddy Hogeborn
Code cleanup and one bug fix.
1996
    for client in tcp_server.clients:
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
1997
        if use_dbus:
1998
            # Emit D-Bus signal
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
1999
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
237.2.2 by Teddy Hogeborn
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
2000
        client.enable()
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
2001
    
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
2002
    tcp_server.enable()
2003
    tcp_server.server_activate()
2004
    
28 by Teddy Hogeborn
* server.conf: New file.
2005
    # Find out what port we got
2006
    service.port = tcp_server.socket.getsockname()[1]
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
2007
    if use_ipv6:
2008
        logger.info(u"Now listening on address %r, port %d,"
2009
                    " flowinfo %d, scope_id %d"
2010
                    % tcp_server.socket.getsockname())
2011
    else:                       # IPv4
2012
        logger.info(u"Now listening on address %r, port %d"
2013
                    % tcp_server.socket.getsockname())
28 by Teddy Hogeborn
* server.conf: New file.
2014
    
29 by Teddy Hogeborn
* plugins.d/mandosclient.c (start_mandos_communication): Changed
2015
    #service.interface = tcp_server.socket.getsockname()[3]
28 by Teddy Hogeborn
* server.conf: New file.
2016
    
2017
    try:
2018
        # From the Avahi example code
2019
        try:
237.2.99 by Teddy Hogeborn
Code cleanup.
2020
            service.activate()
28 by Teddy Hogeborn
* server.conf: New file.
2021
        except dbus.exceptions.DBusException, error:
2022
            logger.critical(u"DBusException: %s", error)
237.2.164 by Teddy Hogeborn
* README (FAQ): Fix typo.
2023
            cleanup()
28 by Teddy Hogeborn
* server.conf: New file.
2024
            sys.exit(1)
2025
        # End of Avahi example code
2026
        
2027
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2028
                             lambda *args, **kwargs:
237.1.2 by Teddy Hogeborn
Further steps towards a D-Bus server interface, plus minor syntax
2029
                             (tcp_server.handle_request
2030
                              (*args[2:], **kwargs) or True))
28 by Teddy Hogeborn
* server.conf: New file.
2031
        
51 by Teddy Hogeborn
* clients.conf: Better comments.
2032
        logger.debug(u"Starting main loop")
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
2033
        main_loop.run()
28 by Teddy Hogeborn
* server.conf: New file.
2034
    except AvahiError, error:
237.2.5 by Teddy Hogeborn
* mandos (AvahiError): Converted to use unicode. All users changed.
2035
        logger.critical(u"AvahiError: %s", error)
237.2.164 by Teddy Hogeborn
* README (FAQ): Fix typo.
2036
        cleanup()
28 by Teddy Hogeborn
* server.conf: New file.
2037
        sys.exit(1)
11 by Teddy Hogeborn
* server.py: Rewritten to use Zeroconf (mDNS/DNS-SD) in place of the
2038
    except KeyboardInterrupt:
15 by Teddy Hogeborn
* mandos-clients.conf ([foo]): Uncommented.
2039
        if debug:
237.2.55 by Teddy Hogeborn
* Makefile (run-server): Use "--no-dbus" unconditionally.
2040
            print >> sys.stderr
237.2.96 by Teddy Hogeborn
Minor code cleanup; one minor bug fix.
2041
        logger.debug(u"Server received KeyboardInterrupt")
2042
    logger.debug(u"Server exiting")
237.2.164 by Teddy Hogeborn
* README (FAQ): Fix typo.
2043
    # Must run before the D-Bus bus name gets deregistered
2044
    cleanup()
16 by Teddy Hogeborn
* Makefile: Include targets for all binaries.
2045
2046
if __name__ == '__main__':
2047
    main()