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