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