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