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