To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 78
- compare with another revision
- download diff
- download tarball
- view history from revision 78
- Committer: Teddy Hogeborn
- Date: 2008-08-16 03:29:08 UTC
- Revision ID: teddy@fukt.bsnet.se-20080816032908-ihw7c05r2mnyk389
Add feature to specify custom environment variables for plugins.
* plugin-runner.c (plugin): New members "environ" and "envc" to
contain possible custom environment.
(getplugin): Return NULL on failure instead of doing exit(); all
callers changed.
(add_to_char_array): New helper function for "add_argument" and
"add_environment".
(addargument): Renamed to "add_argument". Return bool. Call
"add_to_char_array" to actually do things.
(add_environment): New; analogous to "add_argument".
(addcustomargument): Renamed to "add_to_argv" to avoid confusion
with "add_argument".
(main): New options "--global-envs" and "--envs-for" to specify
custom environment for plugins. Print environment for
plugins in debug mode. Use asprintf instead of strcpy and
strcat. Use execve() for plugins with custom environments.
Free environment for plugin when freeing plugin list.
* plugin-runner.c (plugin): New members "environ" and "envc" to
contain possible custom environment.
(getplugin): Return NULL on failure instead of doing exit(); all
callers changed.
(add_to_char_array): New helper function for "add_argument" and
"add_environment".
(addargument): Renamed to "add_argument". Return bool. Call
"add_to_char_array" to actually do things.
(add_environment): New; analogous to "add_argument".
(addcustomargument): Renamed to "add_to_argv" to avoid confusion
with "add_argument".
(main): New options "--global-envs" and "--envs-for" to specify
custom environment for plugins. Print environment for
plugins in debug mode. Use asprintf instead of strcpy and
strcat. Use execve() for plugins with custom environments.
Free environment for plugin when freeing plugin list.
- files added:
- network-protocol.txt
- files removed:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- network-hooks.d
- files renamed:
- plugins.d/mandos-client.c => plugins.d/password-request.c
- plugins.d/mandos-client.xml => plugins.d/password-request.xml
- files modified:
- Makefile
added
removed
mandos
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
# methods "add", "remove", "server_state_changed",
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
# "AvahiService" class, and some lines in "main".
9
# methods "add" and "remove" in the "AvahiService" class, the
10
# "server_state_changed" and "entry_group_state_changed" functions,
11
# and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
16
15
#
17
16
# This program is free software: you can redistribute it and/or modify
18
17
# it under the terms of the GNU General Public License as published by
25
24
# GNU General Public License for more details.
26
25
#
27
26
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
#
31
# Contact the authors at <mandos@recompile.se>.
32
#
33
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
import SocketServer as socketserver
27
# along with this program. If not, see <http://www.gnu.org/licenses/>.
28
#
29
# Contact the authors at <mandos@fukt.bsnet.se>.
30
#
31
32
from __future__ import division
33
34
import SocketServer
38
35
import socket
39
import argparse
36
import select
37
from optparse import OptionParser
40
38
import datetime
41
39
import errno
42
40
import gnutls.crypto
45
43
import gnutls.library.functions
46
44
import gnutls.library.constants
47
45
import gnutls.library.types
48
import ConfigParser as configparser
46
import ConfigParser
49
47
import sys
50
48
import re
51
49
import os
52
50
import signal
51
from sets import Set
53
52
import subprocess
54
53
import atexit
55
54
import stat
56
55
import logging
57
56
import logging.handlers
58
import pwd
59
import contextlib
60
import struct
61
import fcntl
62
import functools
63
import cPickle as pickle
64
import multiprocessing
65
import types
66
import binascii
67
import tempfile
68
57
69
58
import dbus
70
import dbus.service
71
59
import gobject
72
60
import avahi
73
61
from dbus.mainloop.glib import DBusGMainLoop
74
62
import ctypes
75
import ctypes.util
76
import xml.dom.minidom
77
import inspect
78
import GnuPGInterface
79
80
try:
81
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
82
except AttributeError:
83
try:
84
from IN import SO_BINDTODEVICE
85
except ImportError:
86
SO_BINDTODEVICE = None
87
88
version = "1.4.1"
89
stored_state_file = "clients.pickle"
90
91
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
95
96
try:
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
99
.if_nametoindex)
100
except (OSError, AttributeError):
101
def if_nametoindex(interface):
102
"Get an interface index the hard way, i.e. using fcntl()"
103
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
104
with contextlib.closing(socket.socket()) as s:
105
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
struct.pack(str("16s16x"),
107
interface))
108
interface_index = struct.unpack(str("I"),
109
ifreq[16:20])[0]
110
return interface_index
111
112
113
def initlogger(debug, level=logging.WARNING):
114
"""init logger and add loglevel"""
115
116
syslogger.setFormatter(logging.Formatter
117
('Mandos [%(process)d]: %(levelname)s:'
118
' %(message)s'))
119
logger.addHandler(syslogger)
120
121
if debug:
122
console = logging.StreamHandler()
123
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
124
' [%(process)d]:'
125
' %(levelname)s:'
126
' %(message)s'))
127
logger.addHandler(console)
128
logger.setLevel(level)
129
130
131
class PGPError(Exception):
132
"""Exception if encryption/decryption fails"""
133
pass
134
135
136
class PGPEngine(object):
137
"""A simple class for OpenPGP symmetric encryption & decryption"""
138
def __init__(self):
139
self.gnupg = GnuPGInterface.GnuPG()
140
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
141
self.gnupg = GnuPGInterface.GnuPG()
142
self.gnupg.options.meta_interactive = False
143
self.gnupg.options.homedir = self.tempdir
144
self.gnupg.options.extra_args.extend(['--force-mdc',
145
'--quiet',
146
'--no-use-agent'])
147
148
def __enter__(self):
149
return self
150
151
def __exit__ (self, exc_type, exc_value, traceback):
152
self._cleanup()
153
return False
154
155
def __del__(self):
156
self._cleanup()
157
158
def _cleanup(self):
159
if self.tempdir is not None:
160
# Delete contents of tempdir
161
for root, dirs, files in os.walk(self.tempdir,
162
topdown = False):
163
for filename in files:
164
os.remove(os.path.join(root, filename))
165
for dirname in dirs:
166
os.rmdir(os.path.join(root, dirname))
167
# Remove tempdir
168
os.rmdir(self.tempdir)
169
self.tempdir = None
170
171
def password_encode(self, password):
172
# Passphrase can not be empty and can not contain newlines or
173
# NUL bytes. So we prefix it and hex encode it.
174
return b"mandos" + binascii.hexlify(password)
175
176
def encrypt(self, data, password):
177
self.gnupg.passphrase = self.password_encode(password)
178
with open(os.devnull) as devnull:
179
try:
180
proc = self.gnupg.run(['--symmetric'],
181
create_fhs=['stdin', 'stdout'],
182
attach_fhs={'stderr': devnull})
183
with contextlib.closing(proc.handles['stdin']) as f:
184
f.write(data)
185
with contextlib.closing(proc.handles['stdout']) as f:
186
ciphertext = f.read()
187
proc.wait()
188
except IOError as e:
189
raise PGPError(e)
190
self.gnupg.passphrase = None
191
return ciphertext
192
193
def decrypt(self, data, password):
194
self.gnupg.passphrase = self.password_encode(password)
195
with open(os.devnull) as devnull:
196
try:
197
proc = self.gnupg.run(['--decrypt'],
198
create_fhs=['stdin', 'stdout'],
199
attach_fhs={'stderr': devnull})
200
with contextlib.closing(proc.handles['stdin'] ) as f:
201
f.write(data)
202
with contextlib.closing(proc.handles['stdout']) as f:
203
decrypted_plaintext = f.read()
204
proc.wait()
205
except IOError as e:
206
raise PGPError(e)
207
self.gnupg.passphrase = None
208
return decrypted_plaintext
209
210
63
64
version = "1.0"
65
66
logger = logging.Logger('mandos')
67
syslogger = logging.handlers.SysLogHandler\
68
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
69
address = "/dev/log")
70
syslogger.setFormatter(logging.Formatter\
71
('Mandos: %(levelname)s: %(message)s'))
72
logger.addHandler(syslogger)
73
74
console = logging.StreamHandler()
75
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
76
' %(message)s'))
77
logger.addHandler(console)
211
78
212
79
class AvahiError(Exception):
213
def __init__(self, value, *args, **kwargs):
80
def __init__(self, value):
214
81
self.value = value
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
82
def __str__(self):
83
return repr(self.value)
218
84
219
85
class AvahiServiceError(AvahiError):
220
86
pass
225
91
226
92
class AvahiService(object):
227
93
"""An Avahi (Zeroconf) service.
228
229
94
Attributes:
230
95
interface: integer; avahi.IF_UNSPEC or an interface index.
231
96
Used to optionally bind to the specified interface.
239
104
max_renames: integer; maximum number of renames
240
105
rename_count: integer; counter so we only rename after collisions
241
106
a sensible number of times
242
group: D-Bus Entry Group
243
server: D-Bus Server
244
bus: dbus.SystemBus()
245
107
"""
246
108
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
247
servicetype = None, port = None, TXT = None,
248
domain = "", host = "", max_renames = 32768,
249
protocol = avahi.PROTO_UNSPEC, bus = None):
109
type = None, port = None, TXT = None, domain = "",
110
host = "", max_renames = 32768):
250
111
self.interface = interface
251
112
self.name = name
252
self.type = servicetype
113
self.type = type
253
114
self.port = port
254
self.TXT = TXT if TXT is not None else []
115
if TXT is None:
116
self.TXT = []
117
else:
118
self.TXT = TXT
255
119
self.domain = domain
256
120
self.host = host
257
121
self.rename_count = 0
258
122
self.max_renames = max_renames
259
self.protocol = protocol
260
self.group = None # our entry group
261
self.server = None
262
self.bus = bus
263
self.entry_group_state_changed_match = None
264
123
def rename(self):
265
124
"""Derived from the Avahi example code"""
266
125
if self.rename_count >= self.max_renames:
267
logger.critical("No suitable Zeroconf service name found"
268
" after %i retries, exiting.",
269
self.rename_count)
126
logger.critical(u"No suitable service name found after %i"
127
u" retries, exiting.", rename_count)
270
128
raise AvahiServiceError("Too many renames")
271
self.name = unicode(self.server
272
.GetAlternativeServiceName(self.name))
273
logger.info("Changing Zeroconf service name to %r ...",
274
self.name)
129
self.name = server.GetAlternativeServiceName(self.name)
130
logger.info(u"Changing name to %r ...", str(self.name))
131
syslogger.setFormatter(logging.Formatter\
132
('Mandos (%s): %%(levelname)s:'
133
' %%(message)s' % self.name))
275
134
self.remove()
276
try:
277
self.add()
278
except dbus.exceptions.DBusException as error:
279
logger.critical("DBusException: %s", error)
280
self.cleanup()
281
os._exit(1)
135
self.add()
282
136
self.rename_count += 1
283
137
def remove(self):
284
138
"""Derived from the Avahi example code"""
285
if self.entry_group_state_changed_match is not None:
286
self.entry_group_state_changed_match.remove()
287
self.entry_group_state_changed_match = None
288
if self.group is not None:
289
self.group.Reset()
139
if group is not None:
140
group.Reset()
290
141
def add(self):
291
142
"""Derived from the Avahi example code"""
292
self.remove()
293
if self.group is None:
294
self.group = dbus.Interface(
295
self.bus.get_object(avahi.DBUS_NAME,
296
self.server.EntryGroupNew()),
297
avahi.DBUS_INTERFACE_ENTRY_GROUP)
298
self.entry_group_state_changed_match = (
299
self.group.connect_to_signal(
300
'StateChanged', self.entry_group_state_changed))
301
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
302
self.name, self.type)
303
self.group.AddService(
304
self.interface,
305
self.protocol,
306
dbus.UInt32(0), # flags
307
self.name, self.type,
308
self.domain, self.host,
309
dbus.UInt16(self.port),
310
avahi.string_array_to_txt_array(self.TXT))
311
self.group.Commit()
312
def entry_group_state_changed(self, state, error):
313
"""Derived from the Avahi example code"""
314
logger.debug("Avahi entry group state change: %i", state)
315
316
if state == avahi.ENTRY_GROUP_ESTABLISHED:
317
logger.debug("Zeroconf service established.")
318
elif state == avahi.ENTRY_GROUP_COLLISION:
319
logger.info("Zeroconf service name collision.")
320
self.rename()
321
elif state == avahi.ENTRY_GROUP_FAILURE:
322
logger.critical("Avahi: Error in group state changed %s",
323
unicode(error))
324
raise AvahiGroupError("State changed: %s"
325
% unicode(error))
326
def cleanup(self):
327
"""Derived from the Avahi example code"""
328
if self.group is not None:
329
try:
330
self.group.Free()
331
except (dbus.exceptions.UnknownMethodException,
332
dbus.exceptions.DBusException):
333
pass
334
self.group = None
335
self.remove()
336
def server_state_changed(self, state, error=None):
337
"""Derived from the Avahi example code"""
338
logger.debug("Avahi server state change: %i", state)
339
bad_states = { avahi.SERVER_INVALID:
340
"Zeroconf server invalid",
341
avahi.SERVER_REGISTERING: None,
342
avahi.SERVER_COLLISION:
343
"Zeroconf server name collision",
344
avahi.SERVER_FAILURE:
345
"Zeroconf server failure" }
346
if state in bad_states:
347
if bad_states[state] is not None:
348
if error is None:
349
logger.error(bad_states[state])
350
else:
351
logger.error(bad_states[state] + ": %r", error)
352
self.cleanup()
353
elif state == avahi.SERVER_RUNNING:
354
self.add()
355
else:
356
if error is None:
357
logger.debug("Unknown state: %r", state)
358
else:
359
logger.debug("Unknown state: %r: %r", state, error)
360
def activate(self):
361
"""Derived from the Avahi example code"""
362
if self.server is None:
363
self.server = dbus.Interface(
364
self.bus.get_object(avahi.DBUS_NAME,
365
avahi.DBUS_PATH_SERVER,
366
follow_name_owner_changes=True),
367
avahi.DBUS_INTERFACE_SERVER)
368
self.server.connect_to_signal("StateChanged",
369
self.server_state_changed)
370
self.server_state_changed(self.server.GetState())
371
372
class AvahiServiceToSyslog(AvahiService):
373
def rename(self):
374
"""Add the new name to the syslog messages"""
375
ret = AvahiService.rename(self)
376
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
379
% self.name))
380
return ret
381
382
def timedelta_to_milliseconds(td):
383
"Convert a datetime.timedelta() to milliseconds"
384
return ((td.days * 24 * 60 * 60 * 1000)
385
+ (td.seconds * 1000)
386
+ (td.microseconds // 1000))
387
143
global group
144
if group is None:
145
group = dbus.Interface\
146
(bus.get_object(avahi.DBUS_NAME,
147
server.EntryGroupNew()),
148
avahi.DBUS_INTERFACE_ENTRY_GROUP)
149
group.connect_to_signal('StateChanged',
150
entry_group_state_changed)
151
logger.debug(u"Adding service '%s' of type '%s' ...",
152
service.name, service.type)
153
group.AddService(
154
self.interface, # interface
155
avahi.PROTO_INET6, # protocol
156
dbus.UInt32(0), # flags
157
self.name, self.type,
158
self.domain, self.host,
159
dbus.UInt16(self.port),
160
avahi.string_array_to_txt_array(self.TXT))
161
group.Commit()
162
163
# From the Avahi example code:
164
group = None # our entry group
165
# End of Avahi example code
166
167
388
168
class Client(object):
389
169
"""A representation of a client host served by this server.
390
391
170
Attributes:
392
approved: bool(); 'None' if not yet approved/disapproved
393
approval_delay: datetime.timedelta(); Time to wait for approval
394
approval_duration: datetime.timedelta(); Duration of one approval
395
checker: subprocess.Popen(); a running checker process used
396
to see if the client lives.
397
'None' if no process is running.
398
checker_callback_tag: a gobject event source tag, or None
399
checker_command: string; External command which is run to check
400
if client lives. %() expansions are done at
171
name: string; from the config file, used in log messages
172
fingerprint: string (40 or 32 hexadecimal digits); used to
173
uniquely identify the client
174
secret: bytestring; sent verbatim (over TLS) to client
175
host: string; available for use by the checker command
176
created: datetime.datetime(); object creation, not client host
177
last_checked_ok: datetime.datetime() or None if not yet checked OK
178
timeout: datetime.timedelta(); How long from last_checked_ok
179
until this client is invalid
180
interval: datetime.timedelta(); How often to start a new checker
181
stop_hook: If set, called by stop() as stop_hook(self)
182
checker: subprocess.Popen(); a running checker process used
183
to see if the client lives.
184
'None' if no process is running.
185
checker_initiator_tag: a gobject event source tag, or None
186
stop_initiator_tag: - '' -
187
checker_callback_tag: - '' -
188
checker_command: string; External command which is run to check if
189
client lives. %() expansions are done at
401
190
runtime with vars(self) as dict, so that for
402
191
instance %(name)s can be used in the command.
403
checker_initiator_tag: a gobject event source tag, or None
404
created: datetime.datetime(); (UTC) object creation
405
client_structure: Object describing what attributes a client has
406
and is used for storing the client at exit
407
current_checker_command: string; current running checker_command
408
disable_initiator_tag: a gobject event source tag, or None
409
enabled: bool()
410
fingerprint: string (40 or 32 hexadecimal digits); used to
411
uniquely identify the client
412
host: string; available for use by the checker command
413
interval: datetime.timedelta(); How often to start a new checker
414
last_approval_request: datetime.datetime(); (UTC) or None
415
last_checked_ok: datetime.datetime(); (UTC) or None
416
last_checker_status: integer between 0 and 255 reflecting exit
417
status of last checker. -1 reflects crashed
418
checker, or None.
419
last_enabled: datetime.datetime(); (UTC) or None
420
name: string; from the config file, used in log messages and
421
D-Bus identifiers
422
secret: bytestring; sent verbatim (over TLS) to client
423
timeout: datetime.timedelta(); How long from last_checked_ok
424
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
426
runtime_expansions: Allowed attributes for runtime expansion.
427
expires: datetime.datetime(); time (UTC) when a client will be
428
disabled, or None
192
Private attibutes:
193
_timeout: Real variable for 'timeout'
194
_interval: Real variable for 'interval'
195
_timeout_milliseconds: Used when calling gobject.timeout_add()
196
_interval_milliseconds: - '' -
429
197
"""
430
431
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
434
"last_enabled", "name", "timeout")
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
437
"interval": "2m",
438
"checker": "fping -q -- %%(host)s",
439
"host": "",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
442
"approved_by_default": "True",
443
"enabled": "True",
444
}
445
446
def timeout_milliseconds(self):
447
"Return the 'timeout' attribute in milliseconds"
448
return timedelta_to_milliseconds(self.timeout)
449
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
453
454
def interval_milliseconds(self):
455
"Return the 'interval' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.interval)
457
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
460
461
@staticmethod
462
def config_parser(config):
463
"""Construct a new dict of client settings of this form:
464
{ client_name: {setting_name: value, ...}, ...}
465
with exceptions for any special settings as defined above.
466
NOTE: Must be a pure function. Must return the same result
467
value given the same arguments.
468
"""
469
settings = {}
470
for client_name in config.sections():
471
section = dict(config.items(client_name))
472
client = settings[client_name] = {}
473
474
client["host"] = section["host"]
475
# Reformat values from string types to Python types
476
client["approved_by_default"] = config.getboolean(
477
client_name, "approved_by_default")
478
client["enabled"] = config.getboolean(client_name, "enabled")
479
480
client["fingerprint"] = (section["fingerprint"].upper()
481
.replace(" ", ""))
482
if "secret" in section:
483
client["secret"] = section["secret"].decode("base64")
484
elif "secfile" in section:
485
with open(os.path.expanduser(os.path.expandvars
486
(section["secfile"])),
487
"rb") as secfile:
488
client["secret"] = secfile.read()
489
else:
490
raise TypeError("No secret or secfile for section %s"
491
% section)
492
client["timeout"] = string_to_delta(section["timeout"])
493
client["extended_timeout"] = string_to_delta(
494
section["extended_timeout"])
495
client["interval"] = string_to_delta(section["interval"])
496
client["approval_delay"] = string_to_delta(
497
section["approval_delay"])
498
client["approval_duration"] = string_to_delta(
499
section["approval_duration"])
500
client["checker_command"] = section["checker"]
501
client["last_approval_request"] = None
502
client["last_checked_ok"] = None
503
client["last_checker_status"] = None
504
505
return settings
506
507
508
def __init__(self, settings, name = None):
198
def _set_timeout(self, timeout):
199
"Setter function for 'timeout' attribute"
200
self._timeout = timeout
201
self._timeout_milliseconds = ((self.timeout.days
202
* 24 * 60 * 60 * 1000)
203
+ (self.timeout.seconds * 1000)
204
+ (self.timeout.microseconds
205
// 1000))
206
timeout = property(lambda self: self._timeout,
207
_set_timeout)
208
del _set_timeout
209
def _set_interval(self, interval):
210
"Setter function for 'interval' attribute"
211
self._interval = interval
212
self._interval_milliseconds = ((self.interval.days
213
* 24 * 60 * 60 * 1000)
214
+ (self.interval.seconds
215
* 1000)
216
+ (self.interval.microseconds
217
// 1000))
218
interval = property(lambda self: self._interval,
219
_set_interval)
220
del _set_interval
221
def __init__(self, name = None, stop_hook=None, config={}):
509
222
"""Note: the 'checker' key in 'config' sets the
510
223
'checker_command' attribute and *not* the 'checker'
511
224
attribute."""
512
225
self.name = name
513
# adding all client settings
514
for setting, value in settings.iteritems():
515
setattr(self, setting, value)
516
517
if self.enabled:
518
if not hasattr(self, "last_enabled"):
519
self.last_enabled = datetime.datetime.utcnow()
520
if not hasattr(self, "expires"):
521
self.expires = (datetime.datetime.utcnow()
522
+ self.timeout)
523
else:
524
self.last_enabled = None
525
self.expires = None
526
527
logger.debug("Creating client %r", self.name)
226
logger.debug(u"Creating client %r", self.name)
528
227
# Uppercase and remove spaces from fingerprint for later
529
228
# comparison purposes with return value from the fingerprint()
530
229
# function
531
logger.debug(" Fingerprint: %s", self.fingerprint)
532
self.created = settings.get("created", datetime.datetime.utcnow())
533
534
# attributes specific for this server instance
230
self.fingerprint = config["fingerprint"].upper()\
231
.replace(u" ", u"")
232
logger.debug(u" Fingerprint: %s", self.fingerprint)
233
if "secret" in config:
234
self.secret = config["secret"].decode(u"base64")
235
elif "secfile" in config:
236
sf = open(config["secfile"])
237
self.secret = sf.read()
238
sf.close()
239
else:
240
raise TypeError(u"No secret or secfile for client %s"
241
% self.name)
242
self.host = config.get("host", "")
243
self.created = datetime.datetime.now()
244
self.last_checked_ok = None
245
self.timeout = string_to_delta(config["timeout"])
246
self.interval = string_to_delta(config["interval"])
247
self.stop_hook = stop_hook
535
248
self.checker = None
536
249
self.checker_initiator_tag = None
537
self.disable_initiator_tag = None
250
self.stop_initiator_tag = None
538
251
self.checker_callback_tag = None
539
self.current_checker_command = None
540
self.approved = None
541
self.approvals_pending = 0
542
self.changedstate = (multiprocessing_manager
543
.Condition(multiprocessing_manager
544
.Lock()))
545
self.client_structure = [attr for attr in
546
self.__dict__.iterkeys()
547
if not attr.startswith("_")]
548
self.client_structure.append("client_structure")
549
550
for name, t in inspect.getmembers(type(self),
551
lambda obj:
552
isinstance(obj,
553
property)):
554
if not name.startswith("_"):
555
self.client_structure.append(name)
556
557
# Send notice to process children that client state has changed
558
def send_changedstate(self):
559
with self.changedstate:
560
self.changedstate.notify_all()
561
562
def enable(self):
252
self.check_command = config["checker"]
253
def start(self):
563
254
"""Start this client's checker and timeout hooks"""
564
if getattr(self, "enabled", False):
565
# Already enabled
566
return
567
self.send_changedstate()
568
self.expires = datetime.datetime.utcnow() + self.timeout
569
self.enabled = True
570
self.last_enabled = datetime.datetime.utcnow()
571
self.init_checker()
572
573
def disable(self, quiet=True):
574
"""Disable this client."""
575
if not getattr(self, "enabled", False):
255
# Schedule a new checker to be started an 'interval' from now,
256
# and every interval from then on.
257
self.checker_initiator_tag = gobject.timeout_add\
258
(self._interval_milliseconds,
259
self.start_checker)
260
# Also start a new checker *right now*.
261
self.start_checker()
262
# Schedule a stop() when 'timeout' has passed
263
self.stop_initiator_tag = gobject.timeout_add\
264
(self._timeout_milliseconds,
265
self.stop)
266
def stop(self):
267
"""Stop this client.
268
The possibility that a client might be restarted is left open,
269
but not currently used."""
270
# If this client doesn't have a secret, it is already stopped.
271
if hasattr(self, "secret") and self.secret:
272
logger.info(u"Stopping client %s", self.name)
273
self.secret = None
274
else:
576
275
return False
577
if not quiet:
578
self.send_changedstate()
579
if not quiet:
580
logger.info("Disabling client %s", self.name)
581
if getattr(self, "disable_initiator_tag", False):
582
gobject.source_remove(self.disable_initiator_tag)
583
self.disable_initiator_tag = None
584
self.expires = None
276
if getattr(self, "stop_initiator_tag", False):
277
gobject.source_remove(self.stop_initiator_tag)
278
self.stop_initiator_tag = None
585
279
if getattr(self, "checker_initiator_tag", False):
586
280
gobject.source_remove(self.checker_initiator_tag)
587
281
self.checker_initiator_tag = None
588
282
self.stop_checker()
589
self.enabled = False
283
if self.stop_hook:
284
self.stop_hook(self)
590
285
# Do not run this again if called by a gobject.timeout_add
591
286
return False
592
593
287
def __del__(self):
594
self.disable()
595
596
def init_checker(self):
597
# Schedule a new checker to be started an 'interval' from now,
598
# and every interval from then on.
599
self.checker_initiator_tag = (gobject.timeout_add
600
(self.interval_milliseconds(),
601
self.start_checker))
602
# Schedule a disable() when 'timeout' has passed
603
self.disable_initiator_tag = (gobject.timeout_add
604
(self.timeout_milliseconds(),
605
self.disable))
606
# Also start a new checker *right now*.
607
self.start_checker()
608
609
def checker_callback(self, pid, condition, command):
288
self.stop_hook = None
289
self.stop()
290
def checker_callback(self, pid, condition):
610
291
"""The checker has completed, so take appropriate actions."""
292
now = datetime.datetime.now()
611
293
self.checker_callback_tag = None
612
294
self.checker = None
613
if os.WIFEXITED(condition):
614
self.last_checker_status = os.WEXITSTATUS(condition)
615
if self.last_checker_status == 0:
616
logger.info("Checker for %(name)s succeeded",
617
vars(self))
618
self.checked_ok()
619
else:
620
logger.info("Checker for %(name)s failed",
621
vars(self))
622
else:
623
self.last_checker_status = -1
624
logger.warning("Checker for %(name)s crashed?",
295
if os.WIFEXITED(condition) \
296
and (os.WEXITSTATUS(condition) == 0):
297
logger.info(u"Checker for %(name)s succeeded",
298
vars(self))
299
self.last_checked_ok = now
300
gobject.source_remove(self.stop_initiator_tag)
301
self.stop_initiator_tag = gobject.timeout_add\
302
(self._timeout_milliseconds,
303
self.stop)
304
elif not os.WIFEXITED(condition):
305
logger.warning(u"Checker for %(name)s crashed?",
625
306
vars(self))
626
627
def checked_ok(self, timeout=None):
628
"""Bump up the timeout for this client.
629
630
This should only be called when the client has been seen,
631
alive and well.
632
"""
633
if timeout is None:
634
timeout = self.timeout
635
self.last_checked_ok = datetime.datetime.utcnow()
636
if self.disable_initiator_tag is not None:
637
gobject.source_remove(self.disable_initiator_tag)
638
if getattr(self, "enabled", False):
639
self.disable_initiator_tag = (gobject.timeout_add
640
(timedelta_to_milliseconds
641
(timeout), self.disable))
642
self.expires = datetime.datetime.utcnow() + timeout
643
644
def need_approval(self):
645
self.last_approval_request = datetime.datetime.utcnow()
646
307
else:
308
logger.info(u"Checker for %(name)s failed",
309
vars(self))
647
310
def start_checker(self):
648
311
"""Start a new checker subprocess if one is not running.
649
650
312
If a checker already exists, leave it running and do
651
313
nothing."""
652
314
# The reason for not killing a running checker is that if we
655
317
# client would inevitably timeout, since no checker would get
656
318
# a chance to run to completion. If we instead leave running
657
319
# checkers alone, the checker would have to take more time
658
# than 'timeout' for the client to be disabled, which is as it
659
# should be.
660
661
# If a checker exists, make sure it is not a zombie
662
try:
663
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
664
except (AttributeError, OSError) as error:
665
if (isinstance(error, OSError)
666
and error.errno != errno.ECHILD):
667
raise error
668
else:
669
if pid:
670
logger.warning("Checker was a zombie")
671
gobject.source_remove(self.checker_callback_tag)
672
self.checker_callback(pid, status,
673
self.current_checker_command)
674
# Start a new checker if needed
320
# than 'timeout' for the client to be declared invalid, which
321
# is as it should be.
675
322
if self.checker is None:
676
323
try:
677
# In case checker_command has exactly one % operator
678
command = self.checker_command % self.host
324
# In case check_command has exactly one % operator
325
command = self.check_command % self.host
679
326
except TypeError:
680
327
# Escape attributes for the shell
681
escaped_attrs = dict(
682
(attr,
683
re.escape(unicode(str(getattr(self, attr, "")),
684
errors=
685
'replace')))
686
for attr in
687
self.runtime_expansions)
688
328
escaped_attrs = dict((key, re.escape(str(val)))
329
for key, val in
330
vars(self).iteritems())
689
331
try:
690
command = self.checker_command % escaped_attrs
691
except TypeError as error:
692
logger.error('Could not format string "%s":'
693
' %s', self.checker_command, error)
332
command = self.check_command % escaped_attrs
333
except TypeError, error:
334
logger.error(u'Could not format string "%s":'
335
u' %s', self.check_command, error)
694
336
return True # Try again later
695
self.current_checker_command = command
696
337
try:
697
logger.info("Starting checker %r for %s",
338
logger.info(u"Starting checker %r for %s",
698
339
command, self.name)
699
# We don't need to redirect stdout and stderr, since
700
# in normal mode, that is already done by daemon(),
701
# and in debug mode we don't want to. (Stdin is
702
# always replaced by /dev/null.)
703
340
self.checker = subprocess.Popen(command,
704
341
close_fds=True,
705
342
shell=True, cwd="/")
706
self.checker_callback_tag = (gobject.child_watch_add
707
(self.checker.pid,
708
self.checker_callback,
709
data=command))
710
# The checker may have completed before the gobject
711
# watch was added. Check for this.
712
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
713
if pid:
714
gobject.source_remove(self.checker_callback_tag)
715
self.checker_callback(pid, status, command)
716
except OSError as error:
717
logger.error("Failed to start subprocess: %s",
343
self.checker_callback_tag = gobject.child_watch_add\
344
(self.checker.pid,
345
self.checker_callback)
346
except subprocess.OSError, error:
347
logger.error(u"Failed to start subprocess: %s",
718
348
error)
719
349
# Re-run this periodically if run by gobject.timeout_add
720
350
return True
721
722
351
def stop_checker(self):
723
352
"""Force the checker process, if any, to stop."""
724
353
if self.checker_callback_tag:
726
355
self.checker_callback_tag = None
727
356
if getattr(self, "checker", None) is None:
728
357
return
729
logger.debug("Stopping checker for %(name)s", vars(self))
358
logger.debug(u"Stopping checker for %(name)s", vars(self))
730
359
try:
731
360
os.kill(self.checker.pid, signal.SIGTERM)
732
#time.sleep(0.5)
361
#os.sleep(0.5)
733
362
#if self.checker.poll() is None:
734
363
# os.kill(self.checker.pid, signal.SIGKILL)
735
except OSError as error:
364
except OSError, error:
736
365
if error.errno != errno.ESRCH: # No such process
737
366
raise
738
367
self.checker = None
739
740
741
def dbus_service_property(dbus_interface, signature="v",
742
access="readwrite", byte_arrays=False):
743
"""Decorators for marking methods of a DBusObjectWithProperties to
744
become properties on the D-Bus.
745
746
The decorated method will be called with no arguments by "Get"
747
and with one argument by "Set".
748
749
The parameters, where they are supported, are the same as
750
dbus.service.method, except there is only "signature", since the
751
type from Get() and the type sent to Set() is the same.
752
"""
753
# Encoding deeply encoded byte arrays is not supported yet by the
754
# "Set" method, so we fail early here:
755
if byte_arrays and signature != "ay":
756
raise ValueError("Byte arrays not supported for non-'ay'"
757
" signature %r" % signature)
758
def decorator(func):
759
func._dbus_is_property = True
760
func._dbus_interface = dbus_interface
761
func._dbus_signature = signature
762
func._dbus_access = access
763
func._dbus_name = func.__name__
764
if func._dbus_name.endswith("_dbus_property"):
765
func._dbus_name = func._dbus_name[:-14]
766
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
767
return func
768
return decorator
769
770
771
class DBusPropertyException(dbus.exceptions.DBusException):
772
"""A base class for D-Bus property-related exceptions
773
"""
774
def __unicode__(self):
775
return unicode(str(self))
776
777
778
class DBusPropertyAccessException(DBusPropertyException):
779
"""A property's access permissions disallows an operation.
780
"""
781
pass
782
783
784
class DBusPropertyNotFound(DBusPropertyException):
785
"""An attempt was made to access a non-existing property.
786
"""
787
pass
788
789
790
class DBusObjectWithProperties(dbus.service.Object):
791
"""A D-Bus object with properties.
792
793
Classes inheriting from this can use the dbus_service_property
794
decorator to expose methods as D-Bus properties. It exposes the
795
standard Get(), Set(), and GetAll() methods on the D-Bus.
796
"""
797
798
@staticmethod
799
def _is_dbus_property(obj):
800
return getattr(obj, "_dbus_is_property", False)
801
802
def _get_all_dbus_properties(self):
803
"""Returns a generator of (name, attribute) pairs
804
"""
805
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
806
for cls in self.__class__.__mro__
807
for name, prop in
808
inspect.getmembers(cls, self._is_dbus_property))
809
810
def _get_dbus_property(self, interface_name, property_name):
811
"""Returns a bound method if one exists which is a D-Bus
812
property with the specified name and interface.
813
"""
814
for cls in self.__class__.__mro__:
815
for name, value in (inspect.getmembers
816
(cls, self._is_dbus_property)):
817
if (value._dbus_name == property_name
818
and value._dbus_interface == interface_name):
819
return value.__get__(self)
820
821
# No such property
822
raise DBusPropertyNotFound(self.dbus_object_path + ":"
823
+ interface_name + "."
824
+ property_name)
825
826
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
827
out_signature="v")
828
def Get(self, interface_name, property_name):
829
"""Standard D-Bus property Get() method, see D-Bus standard.
830
"""
831
prop = self._get_dbus_property(interface_name, property_name)
832
if prop._dbus_access == "write":
833
raise DBusPropertyAccessException(property_name)
834
value = prop()
835
if not hasattr(value, "variant_level"):
836
return value
837
return type(value)(value, variant_level=value.variant_level+1)
838
839
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
840
def Set(self, interface_name, property_name, value):
841
"""Standard D-Bus property Set() method, see D-Bus standard.
842
"""
843
prop = self._get_dbus_property(interface_name, property_name)
844
if prop._dbus_access == "read":
845
raise DBusPropertyAccessException(property_name)
846
if prop._dbus_get_args_options["byte_arrays"]:
847
# The byte_arrays option is not supported yet on
848
# signatures other than "ay".
849
if prop._dbus_signature != "ay":
850
raise ValueError
851
value = dbus.ByteArray(''.join(unichr(byte)
852
for byte in value))
853
prop(value)
854
855
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
856
out_signature="a{sv}")
857
def GetAll(self, interface_name):
858
"""Standard D-Bus property GetAll() method, see D-Bus
859
standard.
860
861
Note: Will not include properties with access="write".
862
"""
863
properties = {}
864
for name, prop in self._get_all_dbus_properties():
865
if (interface_name
866
and interface_name != prop._dbus_interface):
867
# Interface non-empty but did not match
868
continue
869
# Ignore write-only properties
870
if prop._dbus_access == "write":
871
continue
872
value = prop()
873
if not hasattr(value, "variant_level"):
874
properties[name] = value
875
continue
876
properties[name] = type(value)(value, variant_level=
877
value.variant_level+1)
878
return dbus.Dictionary(properties, signature="sv")
879
880
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
881
out_signature="s",
882
path_keyword='object_path',
883
connection_keyword='connection')
884
def Introspect(self, object_path, connection):
885
"""Standard D-Bus method, overloaded to insert property tags.
886
"""
887
xmlstring = dbus.service.Object.Introspect(self, object_path,
888
connection)
889
try:
890
document = xml.dom.minidom.parseString(xmlstring)
891
def make_tag(document, name, prop):
892
e = document.createElement("property")
893
e.setAttribute("name", name)
894
e.setAttribute("type", prop._dbus_signature)
895
e.setAttribute("access", prop._dbus_access)
896
return e
897
for if_tag in document.getElementsByTagName("interface"):
898
for tag in (make_tag(document, name, prop)
899
for name, prop
900
in self._get_all_dbus_properties()
901
if prop._dbus_interface
902
== if_tag.getAttribute("name")):
903
if_tag.appendChild(tag)
904
# Add the names to the return values for the
905
# "org.freedesktop.DBus.Properties" methods
906
if (if_tag.getAttribute("name")
907
== "org.freedesktop.DBus.Properties"):
908
for cn in if_tag.getElementsByTagName("method"):
909
if cn.getAttribute("name") == "Get":
910
for arg in cn.getElementsByTagName("arg"):
911
if (arg.getAttribute("direction")
912
== "out"):
913
arg.setAttribute("name", "value")
914
elif cn.getAttribute("name") == "GetAll":
915
for arg in cn.getElementsByTagName("arg"):
916
if (arg.getAttribute("direction")
917
== "out"):
918
arg.setAttribute("name", "props")
919
xmlstring = document.toxml("utf-8")
920
document.unlink()
921
except (AttributeError, xml.dom.DOMException,
922
xml.parsers.expat.ExpatError) as error:
923
logger.error("Failed to override Introspection method",
924
error)
925
return xmlstring
926
927
928
def datetime_to_dbus (dt, variant_level=0):
929
"""Convert a UTC datetime.datetime() to a D-Bus type."""
930
if dt is None:
931
return dbus.String("", variant_level = variant_level)
932
return dbus.String(dt.isoformat(),
933
variant_level=variant_level)
934
935
936
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
937
.__metaclass__):
938
"""Applied to an empty subclass of a D-Bus object, this metaclass
939
will add additional D-Bus attributes matching a certain pattern.
940
"""
941
def __new__(mcs, name, bases, attr):
942
# Go through all the base classes which could have D-Bus
943
# methods, signals, or properties in them
944
for base in (b for b in bases
945
if issubclass(b, dbus.service.Object)):
946
# Go though all attributes of the base class
947
for attrname, attribute in inspect.getmembers(base):
948
# Ignore non-D-Bus attributes, and D-Bus attributes
949
# with the wrong interface name
950
if (not hasattr(attribute, "_dbus_interface")
951
or not attribute._dbus_interface
952
.startswith("se.recompile.Mandos")):
953
continue
954
# Create an alternate D-Bus interface name based on
955
# the current name
956
alt_interface = (attribute._dbus_interface
957
.replace("se.recompile.Mandos",
958
"se.bsnet.fukt.Mandos"))
959
# Is this a D-Bus signal?
960
if getattr(attribute, "_dbus_is_signal", False):
961
# Extract the original non-method function by
962
# black magic
963
nonmethod_func = (dict(
964
zip(attribute.func_code.co_freevars,
965
attribute.__closure__))["func"]
966
.cell_contents)
967
# Create a new, but exactly alike, function
968
# object, and decorate it to be a new D-Bus signal
969
# with the alternate D-Bus interface name
970
new_function = (dbus.service.signal
971
(alt_interface,
972
attribute._dbus_signature)
973
(types.FunctionType(
974
nonmethod_func.func_code,
975
nonmethod_func.func_globals,
976
nonmethod_func.func_name,
977
nonmethod_func.func_defaults,
978
nonmethod_func.func_closure)))
979
# Define a creator of a function to call both the
980
# old and new functions, so both the old and new
981
# signals gets sent when the function is called
982
def fixscope(func1, func2):
983
"""This function is a scope container to pass
984
func1 and func2 to the "call_both" function
985
outside of its arguments"""
986
def call_both(*args, **kwargs):
987
"""This function will emit two D-Bus
988
signals by calling func1 and func2"""
989
func1(*args, **kwargs)
990
func2(*args, **kwargs)
991
return call_both
992
# Create the "call_both" function and add it to
993
# the class
994
attr[attrname] = fixscope(attribute,
995
new_function)
996
# Is this a D-Bus method?
997
elif getattr(attribute, "_dbus_is_method", False):
998
# Create a new, but exactly alike, function
999
# object. Decorate it to be a new D-Bus method
1000
# with the alternate D-Bus interface name. Add it
1001
# to the class.
1002
attr[attrname] = (dbus.service.method
1003
(alt_interface,
1004
attribute._dbus_in_signature,
1005
attribute._dbus_out_signature)
1006
(types.FunctionType
1007
(attribute.func_code,
1008
attribute.func_globals,
1009
attribute.func_name,
1010
attribute.func_defaults,
1011
attribute.func_closure)))
1012
# Is this a D-Bus property?
1013
elif getattr(attribute, "_dbus_is_property", False):
1014
# Create a new, but exactly alike, function
1015
# object, and decorate it to be a new D-Bus
1016
# property with the alternate D-Bus interface
1017
# name. Add it to the class.
1018
attr[attrname] = (dbus_service_property
1019
(alt_interface,
1020
attribute._dbus_signature,
1021
attribute._dbus_access,
1022
attribute
1023
._dbus_get_args_options
1024
["byte_arrays"])
1025
(types.FunctionType
1026
(attribute.func_code,
1027
attribute.func_globals,
1028
attribute.func_name,
1029
attribute.func_defaults,
1030
attribute.func_closure)))
1031
return type.__new__(mcs, name, bases, attr)
1032
1033
1034
class ClientDBus(Client, DBusObjectWithProperties):
1035
"""A Client class using D-Bus
1036
1037
Attributes:
1038
dbus_object_path: dbus.ObjectPath
1039
bus: dbus.SystemBus()
1040
"""
1041
1042
runtime_expansions = (Client.runtime_expansions
1043
+ ("dbus_object_path",))
1044
1045
# dbus.service.Object doesn't use super(), so we can't either.
1046
1047
def __init__(self, bus = None, *args, **kwargs):
1048
self.bus = bus
1049
Client.__init__(self, *args, **kwargs)
1050
self._approvals_pending = 0
1051
1052
self._approvals_pending = 0
1053
# Only now, when this client is initialized, can it show up on
1054
# the D-Bus
1055
client_object_name = unicode(self.name).translate(
1056
{ord("."): ord("_"),
1057
ord("-"): ord("_")})
1058
self.dbus_object_path = (dbus.ObjectPath
1059
("/clients/" + client_object_name))
1060
DBusObjectWithProperties.__init__(self, self.bus,
1061
self.dbus_object_path)
1062
1063
def notifychangeproperty(transform_func,
1064
dbus_name, type_func=lambda x: x,
1065
variant_level=1):
1066
""" Modify a variable so that it's a property which announces
1067
its changes to DBus.
1068
1069
transform_fun: Function that takes a value and a variant_level
1070
and transforms it to a D-Bus type.
1071
dbus_name: D-Bus name of the variable
1072
type_func: Function that transform the value before sending it
1073
to the D-Bus. Default: no transform
1074
variant_level: D-Bus variant level. Default: 1
1075
"""
1076
attrname = "_{0}".format(dbus_name)
1077
def setter(self, value):
1078
if hasattr(self, "dbus_object_path"):
1079
if (not hasattr(self, attrname) or
1080
type_func(getattr(self, attrname, None))
1081
!= type_func(value)):
1082
dbus_value = transform_func(type_func(value),
1083
variant_level
1084
=variant_level)
1085
self.PropertyChanged(dbus.String(dbus_name),
1086
dbus_value)
1087
setattr(self, attrname, value)
1088
1089
return property(lambda self: getattr(self, attrname), setter)
1090
1091
1092
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1093
approvals_pending = notifychangeproperty(dbus.Boolean,
1094
"ApprovalPending",
1095
type_func = bool)
1096
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1097
last_enabled = notifychangeproperty(datetime_to_dbus,
1098
"LastEnabled")
1099
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1100
type_func = lambda checker:
1101
checker is not None)
1102
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1103
"LastCheckedOK")
1104
last_approval_request = notifychangeproperty(
1105
datetime_to_dbus, "LastApprovalRequest")
1106
approved_by_default = notifychangeproperty(dbus.Boolean,
1107
"ApprovedByDefault")
1108
approval_delay = notifychangeproperty(dbus.UInt64,
1109
"ApprovalDelay",
1110
type_func =
1111
timedelta_to_milliseconds)
1112
approval_duration = notifychangeproperty(
1113
dbus.UInt64, "ApprovalDuration",
1114
type_func = timedelta_to_milliseconds)
1115
host = notifychangeproperty(dbus.String, "Host")
1116
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1117
type_func =
1118
timedelta_to_milliseconds)
1119
extended_timeout = notifychangeproperty(
1120
dbus.UInt64, "ExtendedTimeout",
1121
type_func = timedelta_to_milliseconds)
1122
interval = notifychangeproperty(dbus.UInt64,
1123
"Interval",
1124
type_func =
1125
timedelta_to_milliseconds)
1126
checker_command = notifychangeproperty(dbus.String, "Checker")
1127
1128
del notifychangeproperty
1129
1130
def __del__(self, *args, **kwargs):
1131
try:
1132
self.remove_from_connection()
1133
except LookupError:
1134
pass
1135
if hasattr(DBusObjectWithProperties, "__del__"):
1136
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1137
Client.__del__(self, *args, **kwargs)
1138
1139
def checker_callback(self, pid, condition, command,
1140
*args, **kwargs):
1141
self.checker_callback_tag = None
1142
self.checker = None
1143
if os.WIFEXITED(condition):
1144
exitstatus = os.WEXITSTATUS(condition)
1145
# Emit D-Bus signal
1146
self.CheckerCompleted(dbus.Int16(exitstatus),
1147
dbus.Int64(condition),
1148
dbus.String(command))
1149
else:
1150
# Emit D-Bus signal
1151
self.CheckerCompleted(dbus.Int16(-1),
1152
dbus.Int64(condition),
1153
dbus.String(command))
1154
1155
return Client.checker_callback(self, pid, condition, command,
1156
*args, **kwargs)
1157
1158
def start_checker(self, *args, **kwargs):
1159
old_checker = self.checker
1160
if self.checker is not None:
1161
old_checker_pid = self.checker.pid
1162
else:
1163
old_checker_pid = None
1164
r = Client.start_checker(self, *args, **kwargs)
1165
# Only if new checker process was started
1166
if (self.checker is not None
1167
and old_checker_pid != self.checker.pid):
1168
# Emit D-Bus signal
1169
self.CheckerStarted(self.current_checker_command)
1170
return r
1171
1172
def _reset_approved(self):
1173
self.approved = None
1174
return False
1175
1176
def approve(self, value=True):
1177
self.send_changedstate()
1178
self.approved = value
1179
gobject.timeout_add(timedelta_to_milliseconds
1180
(self.approval_duration),
1181
self._reset_approved)
1182
1183
1184
## D-Bus methods, signals & properties
1185
_interface = "se.recompile.Mandos.Client"
1186
1187
## Signals
1188
1189
# CheckerCompleted - signal
1190
@dbus.service.signal(_interface, signature="nxs")
1191
def CheckerCompleted(self, exitcode, waitstatus, command):
1192
"D-Bus signal"
1193
pass
1194
1195
# CheckerStarted - signal
1196
@dbus.service.signal(_interface, signature="s")
1197
def CheckerStarted(self, command):
1198
"D-Bus signal"
1199
pass
1200
1201
# PropertyChanged - signal
1202
@dbus.service.signal(_interface, signature="sv")
1203
def PropertyChanged(self, property, value):
1204
"D-Bus signal"
1205
pass
1206
1207
# GotSecret - signal
1208
@dbus.service.signal(_interface)
1209
def GotSecret(self):
1210
"""D-Bus signal
1211
Is sent after a successful transfer of secret from the Mandos
1212
server to mandos-client
1213
"""
1214
pass
1215
1216
# Rejected - signal
1217
@dbus.service.signal(_interface, signature="s")
1218
def Rejected(self, reason):
1219
"D-Bus signal"
1220
pass
1221
1222
# NeedApproval - signal
1223
@dbus.service.signal(_interface, signature="tb")
1224
def NeedApproval(self, timeout, default):
1225
"D-Bus signal"
1226
return self.need_approval()
1227
1228
# NeRwequest - signal
1229
@dbus.service.signal(_interface, signature="s")
1230
def NewRequest(self, ip):
1231
"""D-Bus signal
1232
Is sent after a client request a password.
1233
"""
1234
pass
1235
1236
## Methods
1237
1238
# Approve - method
1239
@dbus.service.method(_interface, in_signature="b")
1240
def Approve(self, value):
1241
self.approve(value)
1242
1243
# CheckedOK - method
1244
@dbus.service.method(_interface)
1245
def CheckedOK(self):
1246
self.checked_ok()
1247
1248
# Enable - method
1249
@dbus.service.method(_interface)
1250
def Enable(self):
1251
"D-Bus method"
1252
self.enable()
1253
1254
# StartChecker - method
1255
@dbus.service.method(_interface)
1256
def StartChecker(self):
1257
"D-Bus method"
1258
self.start_checker()
1259
1260
# Disable - method
1261
@dbus.service.method(_interface)
1262
def Disable(self):
1263
"D-Bus method"
1264
self.disable()
1265
1266
# StopChecker - method
1267
@dbus.service.method(_interface)
1268
def StopChecker(self):
1269
self.stop_checker()
1270
1271
## Properties
1272
1273
# ApprovalPending - property
1274
@dbus_service_property(_interface, signature="b", access="read")
1275
def ApprovalPending_dbus_property(self):
1276
return dbus.Boolean(bool(self.approvals_pending))
1277
1278
# ApprovedByDefault - property
1279
@dbus_service_property(_interface, signature="b",
1280
access="readwrite")
1281
def ApprovedByDefault_dbus_property(self, value=None):
1282
if value is None: # get
1283
return dbus.Boolean(self.approved_by_default)
1284
self.approved_by_default = bool(value)
1285
1286
# ApprovalDelay - property
1287
@dbus_service_property(_interface, signature="t",
1288
access="readwrite")
1289
def ApprovalDelay_dbus_property(self, value=None):
1290
if value is None: # get
1291
return dbus.UInt64(self.approval_delay_milliseconds())
1292
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1293
1294
# ApprovalDuration - property
1295
@dbus_service_property(_interface, signature="t",
1296
access="readwrite")
1297
def ApprovalDuration_dbus_property(self, value=None):
1298
if value is None: # get
1299
return dbus.UInt64(timedelta_to_milliseconds(
1300
self.approval_duration))
1301
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1302
1303
# Name - property
1304
@dbus_service_property(_interface, signature="s", access="read")
1305
def Name_dbus_property(self):
1306
return dbus.String(self.name)
1307
1308
# Fingerprint - property
1309
@dbus_service_property(_interface, signature="s", access="read")
1310
def Fingerprint_dbus_property(self):
1311
return dbus.String(self.fingerprint)
1312
1313
# Host - property
1314
@dbus_service_property(_interface, signature="s",
1315
access="readwrite")
1316
def Host_dbus_property(self, value=None):
1317
if value is None: # get
1318
return dbus.String(self.host)
1319
self.host = unicode(value)
1320
1321
# Created - property
1322
@dbus_service_property(_interface, signature="s", access="read")
1323
def Created_dbus_property(self):
1324
return datetime_to_dbus(self.created)
1325
1326
# LastEnabled - property
1327
@dbus_service_property(_interface, signature="s", access="read")
1328
def LastEnabled_dbus_property(self):
1329
return datetime_to_dbus(self.last_enabled)
1330
1331
# Enabled - property
1332
@dbus_service_property(_interface, signature="b",
1333
access="readwrite")
1334
def Enabled_dbus_property(self, value=None):
1335
if value is None: # get
1336
return dbus.Boolean(self.enabled)
1337
if value:
1338
self.enable()
1339
else:
1340
self.disable()
1341
1342
# LastCheckedOK - property
1343
@dbus_service_property(_interface, signature="s",
1344
access="readwrite")
1345
def LastCheckedOK_dbus_property(self, value=None):
1346
if value is not None:
1347
self.checked_ok()
1348
return
1349
return datetime_to_dbus(self.last_checked_ok)
1350
1351
# Expires - property
1352
@dbus_service_property(_interface, signature="s", access="read")
1353
def Expires_dbus_property(self):
1354
return datetime_to_dbus(self.expires)
1355
1356
# LastApprovalRequest - property
1357
@dbus_service_property(_interface, signature="s", access="read")
1358
def LastApprovalRequest_dbus_property(self):
1359
return datetime_to_dbus(self.last_approval_request)
1360
1361
# Timeout - property
1362
@dbus_service_property(_interface, signature="t",
1363
access="readwrite")
1364
def Timeout_dbus_property(self, value=None):
1365
if value is None: # get
1366
return dbus.UInt64(self.timeout_milliseconds())
1367
self.timeout = datetime.timedelta(0, 0, 0, value)
1368
if getattr(self, "disable_initiator_tag", None) is None:
1369
return
1370
# Reschedule timeout
1371
gobject.source_remove(self.disable_initiator_tag)
1372
self.disable_initiator_tag = None
1373
self.expires = None
1374
time_to_die = timedelta_to_milliseconds((self
1375
.last_checked_ok
1376
+ self.timeout)
1377
- datetime.datetime
1378
.utcnow())
1379
if time_to_die <= 0:
1380
# The timeout has passed
1381
self.disable()
1382
else:
1383
self.expires = (datetime.datetime.utcnow()
1384
+ datetime.timedelta(milliseconds =
1385
time_to_die))
1386
self.disable_initiator_tag = (gobject.timeout_add
1387
(time_to_die, self.disable))
1388
1389
# ExtendedTimeout - property
1390
@dbus_service_property(_interface, signature="t",
1391
access="readwrite")
1392
def ExtendedTimeout_dbus_property(self, value=None):
1393
if value is None: # get
1394
return dbus.UInt64(self.extended_timeout_milliseconds())
1395
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1396
1397
# Interval - property
1398
@dbus_service_property(_interface, signature="t",
1399
access="readwrite")
1400
def Interval_dbus_property(self, value=None):
1401
if value is None: # get
1402
return dbus.UInt64(self.interval_milliseconds())
1403
self.interval = datetime.timedelta(0, 0, 0, value)
1404
if getattr(self, "checker_initiator_tag", None) is None:
1405
return
1406
if self.enabled:
1407
# Reschedule checker run
1408
gobject.source_remove(self.checker_initiator_tag)
1409
self.checker_initiator_tag = (gobject.timeout_add
1410
(value, self.start_checker))
1411
self.start_checker() # Start one now, too
1412
1413
# Checker - property
1414
@dbus_service_property(_interface, signature="s",
1415
access="readwrite")
1416
def Checker_dbus_property(self, value=None):
1417
if value is None: # get
1418
return dbus.String(self.checker_command)
1419
self.checker_command = unicode(value)
1420
1421
# CheckerRunning - property
1422
@dbus_service_property(_interface, signature="b",
1423
access="readwrite")
1424
def CheckerRunning_dbus_property(self, value=None):
1425
if value is None: # get
1426
return dbus.Boolean(self.checker is not None)
1427
if value:
1428
self.start_checker()
1429
else:
1430
self.stop_checker()
1431
1432
# ObjectPath - property
1433
@dbus_service_property(_interface, signature="o", access="read")
1434
def ObjectPath_dbus_property(self):
1435
return self.dbus_object_path # is already a dbus.ObjectPath
1436
1437
# Secret = property
1438
@dbus_service_property(_interface, signature="ay",
1439
access="write", byte_arrays=True)
1440
def Secret_dbus_property(self, value):
1441
self.secret = str(value)
1442
1443
del _interface
1444
1445
1446
class ProxyClient(object):
1447
def __init__(self, child_pipe, fpr, address):
1448
self._pipe = child_pipe
1449
self._pipe.send(('init', fpr, address))
1450
if not self._pipe.recv():
1451
raise KeyError()
1452
1453
def __getattribute__(self, name):
1454
if name == '_pipe':
1455
return super(ProxyClient, self).__getattribute__(name)
1456
self._pipe.send(('getattr', name))
1457
data = self._pipe.recv()
1458
if data[0] == 'data':
1459
return data[1]
1460
if data[0] == 'function':
1461
def func(*args, **kwargs):
1462
self._pipe.send(('funcall', name, args, kwargs))
1463
return self._pipe.recv()[1]
1464
return func
1465
1466
def __setattr__(self, name, value):
1467
if name == '_pipe':
1468
return super(ProxyClient, self).__setattr__(name, value)
1469
self._pipe.send(('setattr', name, value))
1470
1471
1472
class ClientDBusTransitional(ClientDBus):
1473
__metaclass__ = AlternateDBusNamesMetaclass
1474
1475
1476
class ClientHandler(socketserver.BaseRequestHandler, object):
1477
"""A class to handle client connections.
1478
1479
Instantiated once for each connection to handle it.
368
def still_valid(self):
369
"""Has the timeout not yet passed for this client?"""
370
now = datetime.datetime.now()
371
if self.last_checked_ok is None:
372
return now < (self.created + self.timeout)
373
else:
374
return now < (self.last_checked_ok + self.timeout)
375
376
377
def peer_certificate(session):
378
"Return the peer's OpenPGP certificate as a bytestring"
379
# If not an OpenPGP certificate...
380
if gnutls.library.functions.gnutls_certificate_type_get\
381
(session._c_object) \
382
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
383
# ...do the normal thing
384
return session.peer_certificate
385
list_size = ctypes.c_uint()
386
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
387
(session._c_object, ctypes.byref(list_size))
388
if list_size.value == 0:
389
return None
390
cert = cert_list[0]
391
return ctypes.string_at(cert.data, cert.size)
392
393
394
def fingerprint(openpgp):
395
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
396
# New GnuTLS "datum" with the OpenPGP public key
397
datum = gnutls.library.types.gnutls_datum_t\
398
(ctypes.cast(ctypes.c_char_p(openpgp),
399
ctypes.POINTER(ctypes.c_ubyte)),
400
ctypes.c_uint(len(openpgp)))
401
# New empty GnuTLS certificate
402
crt = gnutls.library.types.gnutls_openpgp_crt_t()
403
gnutls.library.functions.gnutls_openpgp_crt_init\
404
(ctypes.byref(crt))
405
# Import the OpenPGP public key into the certificate
406
gnutls.library.functions.gnutls_openpgp_crt_import\
407
(crt, ctypes.byref(datum),
408
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
409
# New buffer for the fingerprint
410
buffer = ctypes.create_string_buffer(20)
411
buffer_length = ctypes.c_size_t()
412
# Get the fingerprint from the certificate into the buffer
413
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
414
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
415
# Deinit the certificate
416
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
417
# Convert the buffer to a Python bytestring
418
fpr = ctypes.string_at(buffer, buffer_length.value)
419
# Convert the bytestring to hexadecimal notation
420
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
421
return hex_fpr
422
423
424
class tcp_handler(SocketServer.BaseRequestHandler, object):
425
"""A TCP request handler class.
426
Instantiated by IPv6_TCPServer for each request to handle it.
1480
427
Note: This will run in its own forked process."""
1481
428
1482
429
def handle(self):
1483
with contextlib.closing(self.server.child_pipe) as child_pipe:
1484
logger.info("TCP connection from: %s",
1485
unicode(self.client_address))
1486
logger.debug("Pipe FD: %d",
1487
self.server.child_pipe.fileno())
1488
1489
session = (gnutls.connection
1490
.ClientSession(self.request,
1491
gnutls.connection
1492
.X509Credentials()))
1493
1494
# Note: gnutls.connection.X509Credentials is really a
1495
# generic GnuTLS certificate credentials object so long as
1496
# no X.509 keys are added to it. Therefore, we can use it
1497
# here despite using OpenPGP certificates.
1498
1499
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1500
# "+AES-256-CBC", "+SHA1",
1501
# "+COMP-NULL", "+CTYPE-OPENPGP",
1502
# "+DHE-DSS"))
1503
# Use a fallback default, since this MUST be set.
1504
priority = self.server.gnutls_priority
1505
if priority is None:
1506
priority = "NORMAL"
1507
(gnutls.library.functions
1508
.gnutls_priority_set_direct(session._c_object,
1509
priority, None))
1510
1511
# Start communication using the Mandos protocol
1512
# Get protocol number
1513
line = self.request.makefile().readline()
1514
logger.debug("Protocol version: %r", line)
1515
try:
1516
if int(line.strip().split()[0]) > 1:
1517
raise RuntimeError
1518
except (ValueError, IndexError, RuntimeError) as error:
1519
logger.error("Unknown protocol version: %s", error)
1520
return
1521
1522
# Start GnuTLS connection
1523
try:
1524
session.handshake()
1525
except gnutls.errors.GNUTLSError as error:
1526
logger.warning("Handshake failed: %s", error)
1527
# Do not run session.bye() here: the session is not
1528
# established. Just abandon the request.
1529
return
1530
logger.debug("Handshake succeeded")
1531
1532
approval_required = False
1533
try:
1534
try:
1535
fpr = self.fingerprint(self.peer_certificate
1536
(session))
1537
except (TypeError,
1538
gnutls.errors.GNUTLSError) as error:
1539
logger.warning("Bad certificate: %s", error)
1540
return
1541
logger.debug("Fingerprint: %s", fpr)
1542
1543
try:
1544
client = ProxyClient(child_pipe, fpr,
1545
self.client_address)
1546
except KeyError:
1547
return
1548
1549
if self.server.use_dbus:
1550
# Emit D-Bus signal
1551
client.NewRequest(str(self.client_address))
1552
1553
if client.approval_delay:
1554
delay = client.approval_delay
1555
client.approvals_pending += 1
1556
approval_required = True
1557
1558
while True:
1559
if not client.enabled:
1560
logger.info("Client %s is disabled",
1561
client.name)
1562
if self.server.use_dbus:
1563
# Emit D-Bus signal
1564
client.Rejected("Disabled")
1565
return
1566
1567
if client.approved or not client.approval_delay:
1568
#We are approved or approval is disabled
1569
break
1570
elif client.approved is None:
1571
logger.info("Client %s needs approval",
1572
client.name)
1573
if self.server.use_dbus:
1574
# Emit D-Bus signal
1575
client.NeedApproval(
1576
client.approval_delay_milliseconds(),
1577
client.approved_by_default)
1578
else:
1579
logger.warning("Client %s was not approved",
1580
client.name)
1581
if self.server.use_dbus:
1582
# Emit D-Bus signal
1583
client.Rejected("Denied")
1584
return
1585
1586
#wait until timeout or approved
1587
time = datetime.datetime.now()
1588
client.changedstate.acquire()
1589
(client.changedstate.wait
1590
(float(client.timedelta_to_milliseconds(delay)
1591
/ 1000)))
1592
client.changedstate.release()
1593
time2 = datetime.datetime.now()
1594
if (time2 - time) >= delay:
1595
if not client.approved_by_default:
1596
logger.warning("Client %s timed out while"
1597
" waiting for approval",
1598
client.name)
1599
if self.server.use_dbus:
1600
# Emit D-Bus signal
1601
client.Rejected("Approval timed out")
1602
return
1603
else:
1604
break
1605
else:
1606
delay -= time2 - time
1607
1608
sent_size = 0
1609
while sent_size < len(client.secret):
1610
try:
1611
sent = session.send(client.secret[sent_size:])
1612
except gnutls.errors.GNUTLSError as error:
1613
logger.warning("gnutls send failed")
1614
return
1615
logger.debug("Sent: %d, remaining: %d",
1616
sent, len(client.secret)
1617
- (sent_size + sent))
1618
sent_size += sent
1619
1620
logger.info("Sending secret to %s", client.name)
1621
# bump the timeout using extended_timeout
1622
client.checked_ok(client.extended_timeout)
1623
if self.server.use_dbus:
1624
# Emit D-Bus signal
1625
client.GotSecret()
1626
1627
finally:
1628
if approval_required:
1629
client.approvals_pending -= 1
1630
try:
1631
session.bye()
1632
except gnutls.errors.GNUTLSError as error:
1633
logger.warning("GnuTLS bye failed")
1634
1635
@staticmethod
1636
def peer_certificate(session):
1637
"Return the peer's OpenPGP certificate as a bytestring"
1638
# If not an OpenPGP certificate...
1639
if (gnutls.library.functions
1640
.gnutls_certificate_type_get(session._c_object)
1641
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1642
# ...do the normal thing
1643
return session.peer_certificate
1644
list_size = ctypes.c_uint(1)
1645
cert_list = (gnutls.library.functions
1646
.gnutls_certificate_get_peers
1647
(session._c_object, ctypes.byref(list_size)))
1648
if not bool(cert_list) and list_size.value != 0:
1649
raise gnutls.errors.GNUTLSError("error getting peer"
1650
" certificate")
1651
if list_size.value == 0:
1652
return None
1653
cert = cert_list[0]
1654
return ctypes.string_at(cert.data, cert.size)
1655
1656
@staticmethod
1657
def fingerprint(openpgp):
1658
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1659
# New GnuTLS "datum" with the OpenPGP public key
1660
datum = (gnutls.library.types
1661
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1662
ctypes.POINTER
1663
(ctypes.c_ubyte)),
1664
ctypes.c_uint(len(openpgp))))
1665
# New empty GnuTLS certificate
1666
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1667
(gnutls.library.functions
1668
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1669
# Import the OpenPGP public key into the certificate
1670
(gnutls.library.functions
1671
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1672
gnutls.library.constants
1673
.GNUTLS_OPENPGP_FMT_RAW))
1674
# Verify the self signature in the key
1675
crtverify = ctypes.c_uint()
1676
(gnutls.library.functions
1677
.gnutls_openpgp_crt_verify_self(crt, 0,
1678
ctypes.byref(crtverify)))
1679
if crtverify.value != 0:
1680
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1681
raise (gnutls.errors.CertificateSecurityError
1682
("Verify failed"))
1683
# New buffer for the fingerprint
1684
buf = ctypes.create_string_buffer(20)
1685
buf_len = ctypes.c_size_t()
1686
# Get the fingerprint from the certificate into the buffer
1687
(gnutls.library.functions
1688
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1689
ctypes.byref(buf_len)))
1690
# Deinit the certificate
1691
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1692
# Convert the buffer to a Python bytestring
1693
fpr = ctypes.string_at(buf, buf_len.value)
1694
# Convert the bytestring to hexadecimal notation
1695
hex_fpr = binascii.hexlify(fpr).upper()
1696
return hex_fpr
1697
1698
1699
class MultiprocessingMixIn(object):
1700
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1701
def sub_process_main(self, request, address):
1702
try:
1703
self.finish_request(request, address)
1704
except Exception:
1705
self.handle_error(request, address)
1706
self.close_request(request)
1707
1708
def process_request(self, request, address):
1709
"""Start a new process to process the request."""
1710
proc = multiprocessing.Process(target = self.sub_process_main,
1711
args = (request,
1712
address))
1713
proc.start()
1714
return proc
1715
1716
1717
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1718
""" adds a pipe to the MixIn """
1719
def process_request(self, request, client_address):
1720
"""Overrides and wraps the original process_request().
1721
1722
This function creates a new pipe in self.pipe
1723
"""
1724
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1725
1726
proc = MultiprocessingMixIn.process_request(self, request,
1727
client_address)
1728
self.child_pipe.close()
1729
self.add_pipe(parent_pipe, proc)
1730
1731
def add_pipe(self, parent_pipe, proc):
1732
"""Dummy function; override as necessary"""
1733
raise NotImplementedError
1734
1735
1736
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1737
socketserver.TCPServer, object):
1738
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1739
430
logger.info(u"TCP connection from: %s",
431
unicode(self.client_address))
432
session = gnutls.connection.ClientSession\
433
(self.request, gnutls.connection.X509Credentials())
434
435
line = self.request.makefile().readline()
436
logger.debug(u"Protocol version: %r", line)
437
try:
438
if int(line.strip().split()[0]) > 1:
439
raise RuntimeError
440
except (ValueError, IndexError, RuntimeError), error:
441
logger.error(u"Unknown protocol version: %s", error)
442
return
443
444
# Note: gnutls.connection.X509Credentials is really a generic
445
# GnuTLS certificate credentials object so long as no X.509
446
# keys are added to it. Therefore, we can use it here despite
447
# using OpenPGP certificates.
448
449
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
450
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
451
# "+DHE-DSS"))
452
priority = "NORMAL" # Fallback default, since this
453
# MUST be set.
454
if self.server.settings["priority"]:
455
priority = self.server.settings["priority"]
456
gnutls.library.functions.gnutls_priority_set_direct\
457
(session._c_object, priority, None);
458
459
try:
460
session.handshake()
461
except gnutls.errors.GNUTLSError, error:
462
logger.warning(u"Handshake failed: %s", error)
463
# Do not run session.bye() here: the session is not
464
# established. Just abandon the request.
465
return
466
try:
467
fpr = fingerprint(peer_certificate(session))
468
except (TypeError, gnutls.errors.GNUTLSError), error:
469
logger.warning(u"Bad certificate: %s", error)
470
session.bye()
471
return
472
logger.debug(u"Fingerprint: %s", fpr)
473
client = None
474
for c in self.server.clients:
475
if c.fingerprint == fpr:
476
client = c
477
break
478
if not client:
479
logger.warning(u"Client not found for fingerprint: %s",
480
fpr)
481
session.bye()
482
return
483
# Have to check if client.still_valid(), since it is possible
484
# that the client timed out while establishing the GnuTLS
485
# session.
486
if not client.still_valid():
487
logger.warning(u"Client %(name)s is invalid",
488
vars(client))
489
session.bye()
490
return
491
sent_size = 0
492
while sent_size < len(client.secret):
493
sent = session.send(client.secret[sent_size:])
494
logger.debug(u"Sent: %d, remaining: %d",
495
sent, len(client.secret)
496
- (sent_size + sent))
497
sent_size += sent
498
session.bye()
499
500
501
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
502
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1740
503
Attributes:
1741
enabled: Boolean; whether this server is activated yet
1742
interface: None or a network interface name (string)
1743
use_ipv6: Boolean; to use IPv6 or not
504
settings: Server settings
505
clients: Set() of Client objects
1744
506
"""
1745
def __init__(self, server_address, RequestHandlerClass,
1746
interface=None, use_ipv6=True):
1747
self.interface = interface
1748
if use_ipv6:
1749
self.address_family = socket.AF_INET6
1750
socketserver.TCPServer.__init__(self, server_address,
1751
RequestHandlerClass)
507
address_family = socket.AF_INET6
508
def __init__(self, *args, **kwargs):
509
if "settings" in kwargs:
510
self.settings = kwargs["settings"]
511
del kwargs["settings"]
512
if "clients" in kwargs:
513
self.clients = kwargs["clients"]
514
del kwargs["clients"]
515
return super(type(self), self).__init__(*args, **kwargs)
1752
516
def server_bind(self):
1753
517
"""This overrides the normal server_bind() function
1754
518
to bind to an interface if one was specified, and also NOT to
1755
519
bind to an address or port if they were not specified."""
1756
if self.interface is not None:
1757
if SO_BINDTODEVICE is None:
1758
logger.error("SO_BINDTODEVICE does not exist;"
1759
" cannot bind to interface %s",
1760
self.interface)
1761
else:
1762
try:
1763
self.socket.setsockopt(socket.SOL_SOCKET,
1764
SO_BINDTODEVICE,
1765
str(self.interface
1766
+ '\0'))
1767
except socket.error as error:
1768
if error[0] == errno.EPERM:
1769
logger.error("No permission to"
1770
" bind to interface %s",
1771
self.interface)
1772
elif error[0] == errno.ENOPROTOOPT:
1773
logger.error("SO_BINDTODEVICE not available;"
1774
" cannot bind to interface %s",
1775
self.interface)
1776
else:
1777
raise
520
if self.settings["interface"]:
521
# 25 is from /usr/include/asm-i486/socket.h
522
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
523
try:
524
self.socket.setsockopt(socket.SOL_SOCKET,
525
SO_BINDTODEVICE,
526
self.settings["interface"])
527
except socket.error, error:
528
if error[0] == errno.EPERM:
529
logger.error(u"No permission to"
530
u" bind to interface %s",
531
self.settings["interface"])
532
else:
533
raise error
1778
534
# Only bind(2) the socket if we really need to.
1779
535
if self.server_address[0] or self.server_address[1]:
1780
536
if not self.server_address[0]:
1781
if self.address_family == socket.AF_INET6:
1782
any_address = "::" # in6addr_any
1783
else:
1784
any_address = socket.INADDR_ANY
1785
self.server_address = (any_address,
537
in6addr_any = "::"
538
self.server_address = (in6addr_any,
1786
539
self.server_address[1])
1787
540
elif not self.server_address[1]:
1788
541
self.server_address = (self.server_address[0],
1789
542
0)
1790
# if self.interface:
543
# if self.settings["interface"]:
1791
544
# self.server_address = (self.server_address[0],
1792
545
# 0, # port
1793
546
# 0, # flowinfo
1794
547
# if_nametoindex
1795
# (self.interface))
1796
return socketserver.TCPServer.server_bind(self)
1797
1798
1799
class MandosServer(IPv6_TCPServer):
1800
"""Mandos server.
1801
1802
Attributes:
1803
clients: set of Client objects
1804
gnutls_priority GnuTLS priority string
1805
use_dbus: Boolean; to emit D-Bus signals or not
1806
1807
Assumes a gobject.MainLoop event loop.
1808
"""
1809
def __init__(self, server_address, RequestHandlerClass,
1810
interface=None, use_ipv6=True, clients=None,
1811
gnutls_priority=None, use_dbus=True):
1812
self.enabled = False
1813
self.clients = clients
1814
if self.clients is None:
1815
self.clients = {}
1816
self.use_dbus = use_dbus
1817
self.gnutls_priority = gnutls_priority
1818
IPv6_TCPServer.__init__(self, server_address,
1819
RequestHandlerClass,
1820
interface = interface,
1821
use_ipv6 = use_ipv6)
1822
def server_activate(self):
1823
if self.enabled:
1824
return socketserver.TCPServer.server_activate(self)
1825
1826
def enable(self):
1827
self.enabled = True
1828
1829
def add_pipe(self, parent_pipe, proc):
1830
# Call "handle_ipc" for both data and EOF events
1831
gobject.io_add_watch(parent_pipe.fileno(),
1832
gobject.IO_IN | gobject.IO_HUP,
1833
functools.partial(self.handle_ipc,
1834
parent_pipe =
1835
parent_pipe,
1836
proc = proc))
1837
1838
def handle_ipc(self, source, condition, parent_pipe=None,
1839
proc = None, client_object=None):
1840
condition_names = {
1841
gobject.IO_IN: "IN", # There is data to read.
1842
gobject.IO_OUT: "OUT", # Data can be written (without
1843
# blocking).
1844
gobject.IO_PRI: "PRI", # There is urgent data to read.
1845
gobject.IO_ERR: "ERR", # Error condition.
1846
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1847
# broken, usually for pipes and
1848
# sockets).
1849
}
1850
conditions_string = ' | '.join(name
1851
for cond, name in
1852
condition_names.iteritems()
1853
if cond & condition)
1854
# error, or the other end of multiprocessing.Pipe has closed
1855
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1856
# Wait for other process to exit
1857
proc.join()
1858
return False
1859
1860
# Read a request from the child
1861
request = parent_pipe.recv()
1862
command = request[0]
1863
1864
if command == 'init':
1865
fpr = request[1]
1866
address = request[2]
1867
1868
for c in self.clients.itervalues():
1869
if c.fingerprint == fpr:
1870
client = c
1871
break
1872
else:
1873
logger.info("Client not found for fingerprint: %s, ad"
1874
"dress: %s", fpr, address)
1875
if self.use_dbus:
1876
# Emit D-Bus signal
1877
mandos_dbus_service.ClientNotFound(fpr,
1878
address[0])
1879
parent_pipe.send(False)
1880
return False
1881
1882
gobject.io_add_watch(parent_pipe.fileno(),
1883
gobject.IO_IN | gobject.IO_HUP,
1884
functools.partial(self.handle_ipc,
1885
parent_pipe =
1886
parent_pipe,
1887
proc = proc,
1888
client_object =
1889
client))
1890
parent_pipe.send(True)
1891
# remove the old hook in favor of the new above hook on
1892
# same fileno
1893
return False
1894
if command == 'funcall':
1895
funcname = request[1]
1896
args = request[2]
1897
kwargs = request[3]
1898
1899
parent_pipe.send(('data', getattr(client_object,
1900
funcname)(*args,
1901
**kwargs)))
1902
1903
if command == 'getattr':
1904
attrname = request[1]
1905
if callable(client_object.__getattribute__(attrname)):
1906
parent_pipe.send(('function',))
1907
else:
1908
parent_pipe.send(('data', client_object
1909
.__getattribute__(attrname)))
1910
1911
if command == 'setattr':
1912
attrname = request[1]
1913
value = request[2]
1914
setattr(client_object, attrname, value)
1915
1916
return True
548
# (self.settings
549
# ["interface"]))
550
return super(type(self), self).server_bind()
1917
551
1918
552
1919
553
def string_to_delta(interval):
1920
554
"""Parse a string and return a datetime.timedelta
1921
555
1922
556
>>> string_to_delta('7d')
1923
557
datetime.timedelta(7)
1924
558
>>> string_to_delta('60s')
1927
561
datetime.timedelta(0, 3600)
1928
562
>>> string_to_delta('24h')
1929
563
datetime.timedelta(1)
1930
>>> string_to_delta('1w')
564
>>> string_to_delta(u'1w')
1931
565
datetime.timedelta(7)
1932
>>> string_to_delta('5m 30s')
1933
datetime.timedelta(0, 330)
1934
566
"""
1935
timevalue = datetime.timedelta(0)
1936
for s in interval.split():
1937
try:
1938
suffix = unicode(s[-1])
1939
value = int(s[:-1])
1940
if suffix == "d":
1941
delta = datetime.timedelta(value)
1942
elif suffix == "s":
1943
delta = datetime.timedelta(0, value)
1944
elif suffix == "m":
1945
delta = datetime.timedelta(0, 0, 0, 0, value)
1946
elif suffix == "h":
1947
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1948
elif suffix == "w":
1949
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1950
else:
1951
raise ValueError("Unknown suffix %r" % suffix)
1952
except (ValueError, IndexError) as e:
1953
raise ValueError(*(e.args))
1954
timevalue += delta
1955
return timevalue
567
try:
568
suffix=unicode(interval[-1])
569
value=int(interval[:-1])
570
if suffix == u"d":
571
delta = datetime.timedelta(value)
572
elif suffix == u"s":
573
delta = datetime.timedelta(0, value)
574
elif suffix == u"m":
575
delta = datetime.timedelta(0, 0, 0, 0, value)
576
elif suffix == u"h":
577
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
578
elif suffix == u"w":
579
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
580
else:
581
raise ValueError
582
except (ValueError, IndexError):
583
raise ValueError
584
return delta
585
586
587
def server_state_changed(state):
588
"""Derived from the Avahi example code"""
589
if state == avahi.SERVER_COLLISION:
590
logger.error(u"Server name collision")
591
service.remove()
592
elif state == avahi.SERVER_RUNNING:
593
service.add()
594
595
596
def entry_group_state_changed(state, error):
597
"""Derived from the Avahi example code"""
598
logger.debug(u"state change: %i", state)
599
600
if state == avahi.ENTRY_GROUP_ESTABLISHED:
601
logger.debug(u"Service established.")
602
elif state == avahi.ENTRY_GROUP_COLLISION:
603
logger.warning(u"Service name collision.")
604
service.rename()
605
elif state == avahi.ENTRY_GROUP_FAILURE:
606
logger.critical(u"Error in group state changed %s",
607
unicode(error))
608
raise AvahiGroupError("State changed: %s", str(error))
609
610
def if_nametoindex(interface):
611
"""Call the C function if_nametoindex(), or equivalent"""
612
global if_nametoindex
613
try:
614
if "ctypes.util" not in sys.modules:
615
import ctypes.util
616
if_nametoindex = ctypes.cdll.LoadLibrary\
617
(ctypes.util.find_library("c")).if_nametoindex
618
except (OSError, AttributeError):
619
if "struct" not in sys.modules:
620
import struct
621
if "fcntl" not in sys.modules:
622
import fcntl
623
def if_nametoindex(interface):
624
"Get an interface index the hard way, i.e. using fcntl()"
625
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
626
s = socket.socket()
627
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
628
struct.pack("16s16x", interface))
629
s.close()
630
interface_index = struct.unpack("I", ifreq[16:20])[0]
631
return interface_index
632
return if_nametoindex(interface)
1956
633
1957
634
1958
635
def daemon(nochdir = False, noclose = False):
1959
636
"""See daemon(3). Standard BSD Unix function.
1960
1961
637
This should really exist as os.daemon, but it doesn't (yet)."""
1962
638
if os.fork():
1963
639
sys.exit()
1971
647
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1972
648
if not stat.S_ISCHR(os.fstat(null).st_mode):
1973
649
raise OSError(errno.ENODEV,
1974
"%s not a character device"
1975
% os.path.devnull)
650
"/dev/null not a character device")
1976
651
os.dup2(null, sys.stdin.fileno())
1977
652
os.dup2(null, sys.stdout.fileno())
1978
653
os.dup2(null, sys.stderr.fileno())
1981
656
1982
657
1983
658
def main():
1984
1985
##################################################################
1986
# Parsing of options, both command line and config file
1987
1988
parser = argparse.ArgumentParser()
1989
parser.add_argument("-v", "--version", action="version",
1990
version = "%%(prog)s %s" % version,
1991
help="show version number and exit")
1992
parser.add_argument("-i", "--interface", metavar="IF",
1993
help="Bind to interface IF")
1994
parser.add_argument("-a", "--address",
1995
help="Address to listen for requests on")
1996
parser.add_argument("-p", "--port", type=int,
1997
help="Port number to receive requests on")
1998
parser.add_argument("--check", action="store_true",
1999
help="Run self-test")
2000
parser.add_argument("--debug", action="store_true",
2001
help="Debug mode; run in foreground and log"
2002
" to terminal")
2003
parser.add_argument("--debuglevel", metavar="LEVEL",
2004
help="Debug level for stdout output")
2005
parser.add_argument("--priority", help="GnuTLS"
2006
" priority string (see GnuTLS documentation)")
2007
parser.add_argument("--servicename",
2008
metavar="NAME", help="Zeroconf service name")
2009
parser.add_argument("--configdir",
2010
default="/etc/mandos", metavar="DIR",
2011
help="Directory to search for configuration"
2012
" files")
2013
parser.add_argument("--no-dbus", action="store_false",
2014
dest="use_dbus", help="Do not provide D-Bus"
2015
" system bus interface")
2016
parser.add_argument("--no-ipv6", action="store_false",
2017
dest="use_ipv6", help="Do not use IPv6")
2018
parser.add_argument("--no-restore", action="store_false",
2019
dest="restore", help="Do not restore stored"
2020
" state")
2021
parser.add_argument("--statedir", metavar="DIR",
2022
help="Directory to save/restore state in")
2023
2024
options = parser.parse_args()
659
global main_loop_started
660
main_loop_started = False
661
662
parser = OptionParser(version = "%%prog %s" % version)
663
parser.add_option("-i", "--interface", type="string",
664
metavar="IF", help="Bind to interface IF")
665
parser.add_option("-a", "--address", type="string",
666
help="Address to listen for requests on")
667
parser.add_option("-p", "--port", type="int",
668
help="Port number to receive requests on")
669
parser.add_option("--check", action="store_true", default=False,
670
help="Run self-test")
671
parser.add_option("--debug", action="store_true",
672
help="Debug mode; run in foreground and log to"
673
" terminal")
674
parser.add_option("--priority", type="string", help="GnuTLS"
675
" priority string (see GnuTLS documentation)")
676
parser.add_option("--servicename", type="string", metavar="NAME",
677
help="Zeroconf service name")
678
parser.add_option("--configdir", type="string",
679
default="/etc/mandos", metavar="DIR",
680
help="Directory to search for configuration"
681
" files")
682
(options, args) = parser.parse_args()
2025
683
2026
684
if options.check:
2027
685
import doctest
2036
694
"priority":
2037
695
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2038
696
"servicename": "Mandos",
2039
"use_dbus": "True",
2040
"use_ipv6": "True",
2041
"debuglevel": "",
2042
"restore": "True",
2043
"statedir": "/var/lib/mandos"
2044
697
}
2045
698
2046
699
# Parse config file for server-global settings
2047
server_config = configparser.SafeConfigParser(server_defaults)
700
server_config = ConfigParser.SafeConfigParser(server_defaults)
2048
701
del server_defaults
2049
server_config.read(os.path.join(options.configdir,
2050
"mandos.conf"))
702
server_config.read(os.path.join(options.configdir, "mandos.conf"))
703
server_section = "server"
2051
704
# Convert the SafeConfigParser object to a dict
2052
server_settings = server_config.defaults()
2053
# Use the appropriate methods on the non-string config options
2054
for option in ("debug", "use_dbus", "use_ipv6"):
2055
server_settings[option] = server_config.getboolean("DEFAULT",
2056
option)
2057
if server_settings["port"]:
2058
server_settings["port"] = server_config.getint("DEFAULT",
2059
"port")
705
server_settings = dict(server_config.items(server_section))
706
# Use getboolean on the boolean config option
707
server_settings["debug"] = server_config.getboolean\
708
(server_section, "debug")
2060
709
del server_config
2061
710
2062
711
# Override the settings from the config file with command line
2063
712
# options, if set.
2064
713
for option in ("interface", "address", "port", "debug",
2065
"priority", "servicename", "configdir",
2066
"use_dbus", "use_ipv6", "debuglevel", "restore",
2067
"statedir"):
714
"priority", "servicename", "configdir"):
2068
715
value = getattr(options, option)
2069
716
if value is not None:
2070
717
server_settings[option] = value
2071
718
del options
2072
# Force all strings to be unicode
2073
for option in server_settings.keys():
2074
if type(server_settings[option]) is str:
2075
server_settings[option] = unicode(server_settings[option])
2076
719
# Now we have our good server settings in "server_settings"
2077
720
2078
##################################################################
2079
2080
# For convenience
2081
721
debug = server_settings["debug"]
2082
debuglevel = server_settings["debuglevel"]
2083
use_dbus = server_settings["use_dbus"]
2084
use_ipv6 = server_settings["use_ipv6"]
2085
stored_state_path = os.path.join(server_settings["statedir"],
2086
stored_state_file)
2087
722
2088
if debug:
2089
initlogger(debug, logging.DEBUG)
2090
else:
2091
if not debuglevel:
2092
initlogger(debug)
2093
else:
2094
level = getattr(logging, debuglevel.upper())
2095
initlogger(debug, level)
723
if not debug:
724
syslogger.setLevel(logging.WARNING)
725
console.setLevel(logging.WARNING)
2096
726
2097
727
if server_settings["servicename"] != "Mandos":
2098
syslogger.setFormatter(logging.Formatter
2099
('Mandos (%s) [%%(process)d]:'
2100
' %%(levelname)s: %%(message)s'
728
syslogger.setFormatter(logging.Formatter\
729
('Mandos (%s): %%(levelname)s:'
730
' %%(message)s'
2101
731
% server_settings["servicename"]))
2102
732
2103
733
# Parse config file with clients
2104
client_config = configparser.SafeConfigParser(Client.client_defaults)
734
client_defaults = { "timeout": "1h",
735
"interval": "5m",
736
"checker": "fping -q -- %%(host)s",
737
}
738
client_config = ConfigParser.SafeConfigParser(client_defaults)
2105
739
client_config.read(os.path.join(server_settings["configdir"],
2106
740
"clients.conf"))
2107
741
2108
global mandos_dbus_service
2109
mandos_dbus_service = None
2110
2111
tcp_server = MandosServer((server_settings["address"],
2112
server_settings["port"]),
2113
ClientHandler,
2114
interface=(server_settings["interface"]
2115
or None),
2116
use_ipv6=use_ipv6,
2117
gnutls_priority=
2118
server_settings["priority"],
2119
use_dbus=use_dbus)
2120
if not debug:
2121
pidfilename = "/var/run/mandos.pid"
2122
try:
2123
pidfile = open(pidfilename, "w")
2124
except IOError:
2125
logger.error("Could not open file %r", pidfilename)
2126
2127
try:
2128
uid = pwd.getpwnam("_mandos").pw_uid
2129
gid = pwd.getpwnam("_mandos").pw_gid
2130
except KeyError:
2131
try:
2132
uid = pwd.getpwnam("mandos").pw_uid
2133
gid = pwd.getpwnam("mandos").pw_gid
2134
except KeyError:
2135
try:
2136
uid = pwd.getpwnam("nobody").pw_uid
2137
gid = pwd.getpwnam("nobody").pw_gid
2138
except KeyError:
2139
uid = 65534
2140
gid = 65534
2141
try:
2142
os.setgid(gid)
2143
os.setuid(uid)
2144
except OSError as error:
2145
if error[0] != errno.EPERM:
2146
raise error
2147
2148
if debug:
2149
# Enable all possible GnuTLS debugging
2150
2151
# "Use a log level over 10 to enable all debugging options."
2152
# - GnuTLS manual
2153
gnutls.library.functions.gnutls_global_set_log_level(11)
2154
2155
@gnutls.library.types.gnutls_log_func
2156
def debug_gnutls(level, string):
2157
logger.debug("GnuTLS: %s", string[:-1])
2158
2159
(gnutls.library.functions
2160
.gnutls_global_set_log_function(debug_gnutls))
2161
2162
# Redirect stdin so all checkers get /dev/null
2163
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2164
os.dup2(null, sys.stdin.fileno())
2165
if null > 2:
2166
os.close(null)
2167
2168
# Need to fork before connecting to D-Bus
2169
if not debug:
2170
# Close all input and output, do double fork, etc.
2171
daemon()
2172
2173
gobject.threads_init()
742
global service
743
service = AvahiService(name = server_settings["servicename"],
744
type = "_mandos._tcp", );
745
if server_settings["interface"]:
746
service.interface = if_nametoindex(server_settings["interface"])
2174
747
2175
748
global main_loop
749
global bus
750
global server
2176
751
# From the Avahi example code
2177
752
DBusGMainLoop(set_as_default=True )
2178
753
main_loop = gobject.MainLoop()
2179
754
bus = dbus.SystemBus()
755
server = dbus.Interface(
756
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
757
avahi.DBUS_INTERFACE_SERVER )
2180
758
# End of Avahi example code
2181
if use_dbus:
2182
try:
2183
bus_name = dbus.service.BusName("se.recompile.Mandos",
2184
bus, do_not_queue=True)
2185
old_bus_name = (dbus.service.BusName
2186
("se.bsnet.fukt.Mandos", bus,
2187
do_not_queue=True))
2188
except dbus.exceptions.NameExistsException as e:
2189
logger.error(unicode(e) + ", disabling D-Bus")
2190
use_dbus = False
2191
server_settings["use_dbus"] = False
2192
tcp_server.use_dbus = False
2193
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2194
service = AvahiServiceToSyslog(name =
2195
server_settings["servicename"],
2196
servicetype = "_mandos._tcp",
2197
protocol = protocol, bus = bus)
2198
if server_settings["interface"]:
2199
service.interface = (if_nametoindex
2200
(str(server_settings["interface"])))
2201
2202
global multiprocessing_manager
2203
multiprocessing_manager = multiprocessing.Manager()
2204
2205
client_class = Client
2206
if use_dbus:
2207
client_class = functools.partial(ClientDBusTransitional,
2208
bus = bus)
2209
2210
client_settings = Client.config_parser(client_config)
2211
old_client_settings = {}
2212
clients_data = {}
2213
2214
# Get client data and settings from last running state.
2215
if server_settings["restore"]:
2216
try:
2217
with open(stored_state_path, "rb") as stored_state:
2218
clients_data, old_client_settings = (pickle.load
2219
(stored_state))
2220
os.remove(stored_state_path)
2221
except IOError as e:
2222
logger.warning("Could not load persistent state: {0}"
2223
.format(e))
2224
if e.errno != errno.ENOENT:
2225
raise
2226
except EOFError as e:
2227
logger.warning("Could not load persistent state: "
2228
"EOFError: {0}".format(e))
2229
2230
with PGPEngine() as pgp:
2231
for client_name, client in clients_data.iteritems():
2232
# Decide which value to use after restoring saved state.
2233
# We have three different values: Old config file,
2234
# new config file, and saved state.
2235
# New config value takes precedence if it differs from old
2236
# config value, otherwise use saved state.
2237
for name, value in client_settings[client_name].items():
2238
try:
2239
# For each value in new config, check if it
2240
# differs from the old config value (Except for
2241
# the "secret" attribute)
2242
if (name != "secret" and
2243
value != old_client_settings[client_name]
2244
[name]):
2245
client[name] = value
2246
except KeyError:
2247
pass
2248
2249
# Clients who has passed its expire date can still be
2250
# enabled if its last checker was successful. Clients
2251
# whose checker failed before we stored its state is
2252
# assumed to have failed all checkers during downtime.
2253
if client["enabled"]:
2254
if datetime.datetime.utcnow() >= client["expires"]:
2255
if not client["last_checked_ok"]:
2256
logger.warning(
2257
"disabling client {0} - Client never "
2258
"performed a successfull checker"
2259
.format(client["name"]))
2260
client["enabled"] = False
2261
elif client["last_checker_status"] != 0:
2262
logger.warning(
2263
"disabling client {0} - Client "
2264
"last checker failed with error code {1}"
2265
.format(client["name"],
2266
client["last_checker_status"]))
2267
client["enabled"] = False
2268
else:
2269
client["expires"] = (datetime.datetime
2270
.utcnow()
2271
+ client["timeout"])
2272
logger.debug("Last checker succeeded,"
2273
" keeping {0} enabled"
2274
.format(client["name"]))
2275
try:
2276
client["secret"] = (
2277
pgp.decrypt(client["encrypted_secret"],
2278
client_settings[client_name]
2279
["secret"]))
2280
except PGPError:
2281
# If decryption fails, we use secret from new settings
2282
logger.debug("Failed to decrypt {0} old secret"
2283
.format(client_name))
2284
client["secret"] = (
2285
client_settings[client_name]["secret"])
2286
2287
2288
# Add/remove clients based on new changes made to config
2289
for client_name in set(old_client_settings) - set(client_settings):
2290
del clients_data[client_name]
2291
for client_name in set(client_settings) - set(old_client_settings):
2292
clients_data[client_name] = client_settings[client_name]
2293
2294
# Create clients all clients
2295
for client_name, client in clients_data.iteritems():
2296
tcp_server.clients[client_name] = client_class(
2297
name = client_name, settings = client)
2298
2299
if not tcp_server.clients:
2300
logger.warning("No clients defined")
759
760
clients = Set()
761
def remove_from_clients(client):
762
clients.remove(client)
763
if not clients:
764
logger.critical(u"No clients left, exiting")
765
sys.exit()
766
767
clients.update(Set(Client(name = section,
768
stop_hook = remove_from_clients,
769
config
770
= dict(client_config.items(section)))
771
for section in client_config.sections()))
772
if not clients:
773
logger.critical(u"No clients defined")
774
sys.exit(1)
775
776
if not debug:
777
logger.removeHandler(console)
778
daemon()
779
780
pidfilename = "/var/run/mandos/mandos.pid"
781
pid = os.getpid()
782
try:
783
pidfile = open(pidfilename, "w")
784
pidfile.write(str(pid) + "\n")
785
pidfile.close()
786
del pidfile
787
except IOError, err:
788
logger.error(u"Could not write %s file with PID %d",
789
pidfilename, os.getpid())
790
791
def cleanup():
792
"Cleanup function; run on exit"
793
global group
794
# From the Avahi example code
795
if not group is None:
796
group.Free()
797
group = None
798
# End of Avahi example code
2301
799
800
while clients:
801
client = clients.pop()
802
client.stop_hook = None
803
client.stop()
804
805
atexit.register(cleanup)
806
2302
807
if not debug:
2303
try:
2304
with pidfile:
2305
pid = os.getpid()
2306
pidfile.write(str(pid) + "\n".encode("utf-8"))
2307
del pidfile
2308
except IOError:
2309
logger.error("Could not write to file %r with PID %d",
2310
pidfilename, pid)
2311
except NameError:
2312
# "pidfile" was never created
2313
pass
2314
del pidfilename
2315
808
signal.signal(signal.SIGINT, signal.SIG_IGN)
2316
2317
809
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2318
810
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2319
811
2320
if use_dbus:
2321
class MandosDBusService(dbus.service.Object):
2322
"""A D-Bus proxy object"""
2323
def __init__(self):
2324
dbus.service.Object.__init__(self, bus, "/")
2325
_interface = "se.recompile.Mandos"
2326
2327
@dbus.service.signal(_interface, signature="o")
2328
def ClientAdded(self, objpath):
2329
"D-Bus signal"
2330
pass
2331
2332
@dbus.service.signal(_interface, signature="ss")
2333
def ClientNotFound(self, fingerprint, address):
2334
"D-Bus signal"
2335
pass
2336
2337
@dbus.service.signal(_interface, signature="os")
2338
def ClientRemoved(self, objpath, name):
2339
"D-Bus signal"
2340
pass
2341
2342
@dbus.service.method(_interface, out_signature="ao")
2343
def GetAllClients(self):
2344
"D-Bus method"
2345
return dbus.Array(c.dbus_object_path
2346
for c in
2347
tcp_server.clients.itervalues())
2348
2349
@dbus.service.method(_interface,
2350
out_signature="a{oa{sv}}")
2351
def GetAllClientsWithProperties(self):
2352
"D-Bus method"
2353
return dbus.Dictionary(
2354
((c.dbus_object_path, c.GetAll(""))
2355
for c in tcp_server.clients.itervalues()),
2356
signature="oa{sv}")
2357
2358
@dbus.service.method(_interface, in_signature="o")
2359
def RemoveClient(self, object_path):
2360
"D-Bus method"
2361
for c in tcp_server.clients.itervalues():
2362
if c.dbus_object_path == object_path:
2363
del tcp_server.clients[c.name]
2364
c.remove_from_connection()
2365
# Don't signal anything except ClientRemoved
2366
c.disable(quiet=True)
2367
# Emit D-Bus signal
2368
self.ClientRemoved(object_path, c.name)
2369
return
2370
raise KeyError(object_path)
2371
2372
del _interface
2373
2374
class MandosDBusServiceTransitional(MandosDBusService):
2375
__metaclass__ = AlternateDBusNamesMetaclass
2376
mandos_dbus_service = MandosDBusServiceTransitional()
2377
2378
def cleanup():
2379
"Cleanup function; run on exit"
2380
service.cleanup()
2381
2382
multiprocessing.active_children()
2383
if not (tcp_server.clients or client_settings):
2384
return
2385
2386
# Store client before exiting. Secrets are encrypted with key
2387
# based on what config file has. If config file is
2388
# removed/edited, old secret will thus be unrecovable.
2389
clients = {}
2390
with PGPEngine() as pgp:
2391
for client in tcp_server.clients.itervalues():
2392
key = client_settings[client.name]["secret"]
2393
client.encrypted_secret = pgp.encrypt(client.secret,
2394
key)
2395
client_dict = {}
2396
2397
# A list of attributes that can not be pickled
2398
# + secret.
2399
exclude = set(("bus", "changedstate", "secret",
2400
"checker"))
2401
for name, typ in (inspect.getmembers
2402
(dbus.service.Object)):
2403
exclude.add(name)
2404
2405
client_dict["encrypted_secret"] = (client
2406
.encrypted_secret)
2407
for attr in client.client_structure:
2408
if attr not in exclude:
2409
client_dict[attr] = getattr(client, attr)
2410
2411
clients[client.name] = client_dict
2412
del client_settings[client.name]["secret"]
2413
2414
try:
2415
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2416
prefix="clients-",
2417
dir=os.path.dirname
2418
(stored_state_path))
2419
with os.fdopen(tempfd, "wb") as stored_state:
2420
pickle.dump((clients, client_settings), stored_state)
2421
os.rename(tempname, stored_state_path)
2422
except (IOError, OSError) as e:
2423
logger.warning("Could not save persistent state: {0}"
2424
.format(e))
2425
if not debug:
2426
try:
2427
os.remove(tempname)
2428
except NameError:
2429
pass
2430
if e.errno not in set((errno.ENOENT, errno.EACCES,
2431
errno.EEXIST)):
2432
raise e
2433
2434
# Delete all clients, and settings from config
2435
while tcp_server.clients:
2436
name, client = tcp_server.clients.popitem()
2437
if use_dbus:
2438
client.remove_from_connection()
2439
# Don't signal anything except ClientRemoved
2440
client.disable(quiet=True)
2441
if use_dbus:
2442
# Emit D-Bus signal
2443
mandos_dbus_service.ClientRemoved(client
2444
.dbus_object_path,
2445
client.name)
2446
client_settings.clear()
2447
2448
atexit.register(cleanup)
2449
2450
for client in tcp_server.clients.itervalues():
2451
if use_dbus:
2452
# Emit D-Bus signal
2453
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2454
# Need to initiate checking of clients
2455
if client.enabled:
2456
client.init_checker()
2457
2458
tcp_server.enable()
2459
tcp_server.server_activate()
2460
812
for client in clients:
813
client.start()
814
815
tcp_server = IPv6_TCPServer((server_settings["address"],
816
server_settings["port"]),
817
tcp_handler,
818
settings=server_settings,
819
clients=clients)
2461
820
# Find out what port we got
2462
821
service.port = tcp_server.socket.getsockname()[1]
2463
if use_ipv6:
2464
logger.info("Now listening on address %r, port %d,"
2465
" flowinfo %d, scope_id %d"
2466
% tcp_server.socket.getsockname())
2467
else: # IPv4
2468
logger.info("Now listening on address %r, port %d"
2469
% tcp_server.socket.getsockname())
822
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
823
u" scope_id %d" % tcp_server.socket.getsockname())
2470
824
2471
825
#service.interface = tcp_server.socket.getsockname()[3]
2472
826
2473
827
try:
2474
828
# From the Avahi example code
829
server.connect_to_signal("StateChanged", server_state_changed)
2475
830
try:
2476
service.activate()
2477
except dbus.exceptions.DBusException as error:
2478
logger.critical("DBusException: %s", error)
2479
cleanup()
831
server_state_changed(server.GetState())
832
except dbus.exceptions.DBusException, error:
833
logger.critical(u"DBusException: %s", error)
2480
834
sys.exit(1)
2481
835
# End of Avahi example code
2482
836
2483
837
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2484
838
lambda *args, **kwargs:
2485
(tcp_server.handle_request
2486
(*args[2:], **kwargs) or True))
839
tcp_server.handle_request\
840
(*args[2:], **kwargs) or True)
2487
841
2488
logger.debug("Starting main loop")
842
logger.debug(u"Starting main loop")
843
main_loop_started = True
2489
844
main_loop.run()
2490
except AvahiError as error:
2491
logger.critical("AvahiError: %s", error)
2492
cleanup()
845
except AvahiError, error:
846
logger.critical(u"AvahiError: %s" + unicode(error))
2493
847
sys.exit(1)
2494
848
except KeyboardInterrupt:
2495
849
if debug:
2496
print("", file=sys.stderr)
2497
logger.debug("Server received KeyboardInterrupt")
2498
logger.debug("Server exiting")
2499
# Must run before the D-Bus bus name gets deregistered
2500
cleanup()
850
print
2501
851
2502
852
if __name__ == '__main__':
2503
853
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0