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 479
- compare with another revision
- download diff
- download tarball
- view history from revision 479
- Committer: Teddy Hogeborn
- Date: 2011-03-17 18:28:22 UTC
- Revision ID: teddy@fukt.bsnet.se-20110317182822-miiq4c3eaexy0yo4
* plugins.d/askpass-fifo.c (main): Don't print message if FIFO exists.
- 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-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 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
import optparse
39
import argparse
39
40
import datetime
40
41
import errno
41
42
import gnutls.crypto
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.5"
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.3.0"
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,
74
address = "/dev/log"))
91
address = str("/dev/log")))
75
92
syslogger.setFormatter(logging.Formatter
76
93
('Mandos [%(process)d]: %(levelname)s:'
77
94
' %(message)s'))
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
domain = "", host = "", max_renames = 32768):
139
domain = "", host = "", 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:
130
logger.critical(u"No suitable Zeroconf service name found"
131
u" after %i retries, exiting.",
157
logger.critical("No suitable Zeroconf service name found"
158
" after %i retries, exiting.",
132
159
self.rename_count)
133
raise AvahiServiceError(u"Too many renames")
134
self.name = server.GetAlternativeServiceName(self.name)
135
logger.info(u"Changing Zeroconf service name to %r ...",
136
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)
137
164
syslogger.setFormatter(logging.Formatter
138
('Mandos (%s): %%(levelname)s:'
139
' %%(message)s' % self.name))
165
('Mandos (%s) [%%(process)d]:'
166
' %%(levelname)s: %%(message)s'
167
% self.name))
140
168
self.remove()
141
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)
142
175
self.rename_count += 1
143
176
def remove(self):
144
177
"""Derived from the Avahi example code"""
145
if group is not None:
146
group.Reset()
178
if self.group is not None:
179
self.group.Reset()
147
180
def add(self):
148
181
"""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)
157
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):
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):
180
241
"""A representation of a client host served by this server.
242
181
243
Attributes:
182
name: string; from the config file, used in log messages and
183
D-Bus identifiers
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
247
checker: subprocess.Popen(); a running checker process used
248
to see if the client lives.
249
'None' if no process is running.
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
253
runtime with vars(self) as dict, so that for
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
257
current_checker_command: string; current running checker_command
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()
184
261
fingerprint: string (40 or 32 hexadecimal digits); used to
185
262
uniquely identify the client
186
secret: bytestring; sent verbatim (over TLS) to client
187
263
host: string; available for use by the checker command
188
created: datetime.datetime(); (UTC) object creation
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
189
267
last_enabled: datetime.datetime(); (UTC)
190
enabled: bool()
191
last_checked_ok: datetime.datetime(); (UTC) or None
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
192
271
timeout: datetime.timedelta(); How long from last_checked_ok
193
until this client is invalid
194
interval: datetime.timedelta(); How often to start a new checker
195
disable_hook: If set, called by disable() as disable_hook(self)
196
checker: subprocess.Popen(); a running checker process used
197
to see if the client lives.
198
'None' if no process is running.
199
checker_initiator_tag: a gobject event source tag, or None
200
disable_initiator_tag: - '' -
201
checker_callback_tag: - '' -
202
checker_command: string; External command which is run to check if
203
client lives. %() expansions are done at
204
runtime with vars(self) as dict, so that for
205
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
272
until this client is disabled
273
runtime_expansions: Allowed attributes for runtime expansion.
208
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
209
288
def timeout_milliseconds(self):
210
289
"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))
290
return self._timedelta_to_milliseconds(self.timeout)
214
291
215
292
def interval_milliseconds(self):
216
293
"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))
294
return self._timedelta_to_milliseconds(self.interval)
295
296
def approval_delay_milliseconds(self):
297
return self._timedelta_to_milliseconds(self.approval_delay)
220
298
221
def __init__(self, name = None, disable_hook=None, config=None,
222
use_dbus=True):
299
def __init__(self, name = None, disable_hook=None, config=None):
223
300
"""Note: the 'checker' key in 'config' sets the
224
301
'checker_command' attribute and *not* the 'checker'
225
302
attribute."""
226
303
self.name = name
227
304
if config is None:
228
305
config = {}
229
logger.debug(u"Creating client %r", self.name)
230
self.use_dbus = False # During __init__
306
logger.debug("Creating client %r", self.name)
231
307
# Uppercase and remove spaces from fingerprint for later
232
308
# comparison purposes with return value from the fingerprint()
233
309
# function
234
310
self.fingerprint = (config["fingerprint"].upper()
235
.replace(u" ", u""))
236
logger.debug(u" Fingerprint: %s", self.fingerprint)
311
.replace(" ", ""))
312
logger.debug(" Fingerprint: %s", self.fingerprint)
237
313
if "secret" in config:
238
self.secret = config["secret"].decode(u"base64")
314
self.secret = config["secret"].decode("base64")
239
315
elif "secfile" in config:
240
with closing(open(os.path.expanduser
241
(os.path.expandvars
242
(config["secfile"])))) as secfile:
316
with open(os.path.expanduser(os.path.expandvars
317
(config["secfile"])),
318
"rb") as secfile:
243
319
self.secret = secfile.read()
244
320
else:
245
raise TypeError(u"No secret or secfile for client %s"
321
raise TypeError("No secret or secfile for client %s"
246
322
% self.name)
247
323
self.host = config.get("host", "")
248
324
self.created = datetime.datetime.utcnow()
249
325
self.enabled = False
326
self.last_approval_request = None
250
327
self.last_enabled = None
251
328
self.last_checked_ok = None
252
329
self.timeout = string_to_delta(config["timeout"])
257
334
self.disable_initiator_tag = None
258
335
self.checker_callback_tag = None
259
336
self.checker_command = config["checker"]
337
self.current_checker_command = None
260
338
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)
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())
270
348
349
def send_changedstate(self):
350
self.changedstate.acquire()
351
self.changedstate.notify_all()
352
self.changedstate.release()
353
271
354
def enable(self):
272
355
"""Start this client's checker and timeout hooks"""
356
if getattr(self, "enabled", False):
357
# Already enabled
358
return
359
self.send_changedstate()
273
360
self.last_enabled = datetime.datetime.utcnow()
274
361
# Schedule a new checker to be started an 'interval' from now,
275
362
# and every interval from then on.
276
363
self.checker_initiator_tag = (gobject.timeout_add
277
364
(self.interval_milliseconds(),
278
365
self.start_checker))
279
# Also start a new checker *right now*.
280
self.start_checker()
281
366
# Schedule a disable() when 'timeout' has passed
282
367
self.disable_initiator_tag = (gobject.timeout_add
283
368
(self.timeout_milliseconds(),
284
369
self.disable))
285
370
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)))
371
# Also start a new checker *right now*.
372
self.start_checker()
293
373
294
def disable(self):
374
def disable(self, quiet=True):
295
375
"""Disable this client."""
296
376
if not getattr(self, "enabled", False):
297
377
return False
298
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)
299
382
if getattr(self, "disable_initiator_tag", False):
300
383
gobject.source_remove(self.disable_initiator_tag)
301
384
self.disable_initiator_tag = None
306
389
if self.disable_hook:
307
390
self.disable_hook(self)
308
391
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
392
# Do not run this again if called by a gobject.timeout_add
314
393
return False
315
394
321
400
"""The checker has completed, so take appropriate actions."""
322
401
self.checker_callback_tag = None
323
402
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
403
if os.WIFEXITED(condition):
329
404
exitstatus = os.WEXITSTATUS(condition)
330
405
if exitstatus == 0:
331
logger.info(u"Checker for %(name)s succeeded",
406
logger.info("Checker for %(name)s succeeded",
332
407
vars(self))
333
408
self.checked_ok()
334
409
else:
335
logger.info(u"Checker for %(name)s failed",
410
logger.info("Checker for %(name)s failed",
336
411
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
412
else:
343
logger.warning(u"Checker for %(name)s crashed?",
413
logger.warning("Checker for %(name)s crashed?",
344
414
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
415
351
416
def checked_ok(self):
352
417
"""Bump up the timeout for this client.
418
353
419
This should only be called when the client has been seen,
354
420
alive and well.
355
421
"""
358
424
self.disable_initiator_tag = (gobject.timeout_add
359
425
(self.timeout_milliseconds(),
360
426
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)))
427
428
def need_approval(self):
429
self.last_approval_request = datetime.datetime.utcnow()
367
430
368
431
def start_checker(self):
369
432
"""Start a new checker subprocess if one is not running.
433
370
434
If a checker already exists, leave it running and do
371
435
nothing."""
372
436
# The reason for not killing a running checker is that if we
375
439
# client would inevitably timeout, since no checker would get
376
440
# a chance to run to completion. If we instead leave running
377
441
# 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.
442
# than 'timeout' for the client to be disabled, which is as it
443
# should be.
444
445
# If a checker exists, make sure it is not a zombie
446
try:
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:
453
if pid:
454
logger.warning("Checker was a zombie")
455
gobject.source_remove(self.checker_callback_tag)
456
self.checker_callback(pid, status,
457
self.current_checker_command)
458
# Start a new checker if needed
380
459
if self.checker is None:
381
460
try:
382
461
# In case checker_command has exactly one % operator
383
462
command = self.checker_command % self.host
384
463
except TypeError:
385
464
# Escape attributes for the shell
386
escaped_attrs = dict((key, re.escape(str(val)))
387
for key, val in
388
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
389
473
try:
390
474
command = self.checker_command % escaped_attrs
391
475
except TypeError, error:
392
logger.error(u'Could not format string "%s":'
393
u' %s', self.checker_command, error)
476
logger.error('Could not format string "%s":'
477
' %s', self.checker_command, error)
394
478
return True # Try again later
479
self.current_checker_command = command
395
480
try:
396
logger.info(u"Starting checker %r for %s",
481
logger.info("Starting checker %r for %s",
397
482
command, self.name)
398
483
# We don't need to redirect stdout and stderr, since
399
484
# in normal mode, that is already done by daemon(),
402
487
self.checker = subprocess.Popen(command,
403
488
close_fds=True,
404
489
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))
411
490
self.checker_callback_tag = (gobject.child_watch_add
412
491
(self.checker.pid,
413
492
self.checker_callback,
419
498
gobject.source_remove(self.checker_callback_tag)
420
499
self.checker_callback(pid, status, command)
421
500
except OSError, error:
422
logger.error(u"Failed to start subprocess: %s",
501
logger.error("Failed to start subprocess: %s",
423
502
error)
424
503
# Re-run this periodically if run by gobject.timeout_add
425
504
return True
431
510
self.checker_callback_tag = None
432
511
if getattr(self, "checker", None) is None:
433
512
return
434
logger.debug(u"Stopping checker for %(name)s", vars(self))
513
logger.debug("Stopping checker for %(name)s", vars(self))
435
514
try:
436
515
os.kill(self.checker.pid, signal.SIGTERM)
437
#os.sleep(0.5)
516
#time.sleep(0.5)
438
517
#if self.checker.poll() is None:
439
518
# os.kill(self.checker.pid, signal.SIGKILL)
440
519
except OSError, error:
441
520
if error.errno != errno.ESRCH: # No such process
442
521
raise
443
522
self.checker = None
444
if self.use_dbus:
445
self.PropertyChanged(dbus.String(u"checker_running"),
446
dbus.Boolean(False, variant_level=1))
447
448
def still_valid(self):
449
"""Has the timeout not yet passed for this client?"""
450
if not getattr(self, "enabled", False):
451
return False
452
now = datetime.datetime.utcnow()
453
if self.last_checked_ok is None:
454
return now < (self.created + self.timeout)
455
else:
456
return now < (self.last_checked_ok + self.timeout)
457
458
## D-Bus methods & signals
459
_interface = u"se.bsnet.fukt.Mandos.Client"
460
461
# CheckedOK - method
462
CheckedOK = dbus.service.method(_interface)(checked_ok)
463
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
464
875
465
876
# CheckerCompleted - signal
466
877
@dbus.service.signal(_interface, signature="nxs")
474
885
"D-Bus signal"
475
886
pass
476
887
477
# GetAllProperties - method
478
@dbus.service.method(_interface, out_signature="a{sv}")
479
def GetAllProperties(self):
480
"D-Bus method"
481
return dbus.Dictionary({
482
dbus.String("name"):
483
dbus.String(self.name, variant_level=1),
484
dbus.String("fingerprint"):
485
dbus.String(self.fingerprint, variant_level=1),
486
dbus.String("host"):
487
dbus.String(self.host, variant_level=1),
488
dbus.String("created"):
489
_datetime_to_dbus(self.created, variant_level=1),
490
dbus.String("last_enabled"):
491
(_datetime_to_dbus(self.last_enabled,
492
variant_level=1)
493
if self.last_enabled is not None
494
else dbus.Boolean(False, variant_level=1)),
495
dbus.String("enabled"):
496
dbus.Boolean(self.enabled, variant_level=1),
497
dbus.String("last_checked_ok"):
498
(_datetime_to_dbus(self.last_checked_ok,
499
variant_level=1)
500
if self.last_checked_ok is not None
501
else dbus.Boolean (False, variant_level=1)),
502
dbus.String("timeout"):
503
dbus.UInt64(self.timeout_milliseconds(),
504
variant_level=1),
505
dbus.String("interval"):
506
dbus.UInt64(self.interval_milliseconds(),
507
variant_level=1),
508
dbus.String("checker"):
509
dbus.String(self.checker_command,
510
variant_level=1),
511
dbus.String("checker_running"):
512
dbus.Boolean(self.checker is not None,
513
variant_level=1),
514
dbus.String("object_path"):
515
dbus.ObjectPath(self.dbus_object_path,
516
variant_level=1)
517
}, signature="sv")
518
519
# IsStillValid - method
520
IsStillValid = (dbus.service.method(_interface, out_signature="b")
521
(still_valid))
522
IsStillValid.__name__ = "IsStillValid"
523
524
888
# PropertyChanged - signal
525
889
@dbus.service.signal(_interface, signature="sv")
526
890
def PropertyChanged(self, property, value):
527
891
"D-Bus signal"
528
892
pass
529
893
530
# SetChecker - method
531
@dbus.service.method(_interface, in_signature="s")
532
def SetChecker(self, checker):
533
"D-Bus setter method"
534
self.checker_command = checker
535
# Emit D-Bus signal
536
self.PropertyChanged(dbus.String(u"checker"),
537
dbus.String(self.checker_command,
538
variant_level=1))
539
540
# SetHost - method
541
@dbus.service.method(_interface, in_signature="s")
542
def SetHost(self, host):
543
"D-Bus setter method"
544
self.host = host
545
# Emit D-Bus signal
546
self.PropertyChanged(dbus.String(u"host"),
547
dbus.String(self.host, variant_level=1))
548
549
# SetInterval - method
550
@dbus.service.method(_interface, in_signature="t")
551
def SetInterval(self, milliseconds):
552
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
553
# Emit D-Bus signal
554
self.PropertyChanged(dbus.String(u"interval"),
555
(dbus.UInt64(self.interval_milliseconds(),
556
variant_level=1)))
557
558
# SetSecret - method
559
@dbus.service.method(_interface, in_signature="ay",
560
byte_arrays=True)
561
def SetSecret(self, secret):
562
"D-Bus setter method"
563
self.secret = str(secret)
564
565
# SetTimeout - method
566
@dbus.service.method(_interface, in_signature="t")
567
def SetTimeout(self, milliseconds):
568
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
569
# Emit D-Bus signal
570
self.PropertyChanged(dbus.String(u"timeout"),
571
(dbus.UInt64(self.timeout_milliseconds(),
572
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()
573
926
574
927
# Enable - method
575
Enable = dbus.service.method(_interface)(enable)
576
Enable.__name__ = "Enable"
928
@dbus.service.method(_interface)
929
def Enable(self):
930
"D-Bus method"
931
self.enable()
577
932
578
933
# StartChecker - method
579
934
@dbus.service.method(_interface)
588
943
self.disable()
589
944
590
945
# StopChecker - method
591
StopChecker = dbus.service.method(_interface)(stop_checker)
592
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)
593
1135
594
1136
del _interface
595
1137
596
1138
597
def peer_certificate(session):
598
"Return the peer's OpenPGP certificate as a bytestring"
599
# If not an OpenPGP certificate...
600
if (gnutls.library.functions
601
.gnutls_certificate_type_get(session._c_object)
602
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
603
# ...do the normal thing
604
return session.peer_certificate
605
list_size = ctypes.c_uint(1)
606
cert_list = (gnutls.library.functions
607
.gnutls_certificate_get_peers
608
(session._c_object, ctypes.byref(list_size)))
609
if not bool(cert_list) and list_size.value != 0:
610
raise gnutls.errors.GNUTLSError("error getting peer"
611
" certificate")
612
if list_size.value == 0:
613
return None
614
cert = cert_list[0]
615
return ctypes.string_at(cert.data, cert.size)
616
617
618
def fingerprint(openpgp):
619
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
620
# New GnuTLS "datum" with the OpenPGP public key
621
datum = (gnutls.library.types
622
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
623
ctypes.POINTER
624
(ctypes.c_ubyte)),
625
ctypes.c_uint(len(openpgp))))
626
# New empty GnuTLS certificate
627
crt = gnutls.library.types.gnutls_openpgp_crt_t()
628
(gnutls.library.functions
629
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
630
# Import the OpenPGP public key into the certificate
631
(gnutls.library.functions
632
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
633
gnutls.library.constants
634
.GNUTLS_OPENPGP_FMT_RAW))
635
# Verify the self signature in the key
636
crtverify = ctypes.c_uint()
637
(gnutls.library.functions
638
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
639
if crtverify.value != 0:
640
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
641
raise gnutls.errors.CertificateSecurityError("Verify failed")
642
# New buffer for the fingerprint
643
buf = ctypes.create_string_buffer(20)
644
buf_len = ctypes.c_size_t()
645
# Get the fingerprint from the certificate into the buffer
646
(gnutls.library.functions
647
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
648
ctypes.byref(buf_len)))
649
# Deinit the certificate
650
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
651
# Convert the buffer to a Python bytestring
652
fpr = ctypes.string_at(buf, buf_len.value)
653
# Convert the bytestring to hexadecimal notation
654
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
655
return hex_fpr
656
657
658
class TCP_handler(SocketServer.BaseRequestHandler, object):
659
"""A TCP request handler class.
660
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.
661
1169
Note: This will run in its own forked process."""
662
1170
663
1171
def handle(self):
664
logger.info(u"TCP connection from: %s",
665
unicode(self.client_address))
666
session = (gnutls.connection
667
.ClientSession(self.request,
668
gnutls.connection
669
.X509Credentials()))
670
671
line = self.request.makefile().readline()
672
logger.debug(u"Protocol version: %r", line)
673
try:
674
if int(line.strip().split()[0]) > 1:
675
raise RuntimeError
676
except (ValueError, IndexError, RuntimeError), error:
677
logger.error(u"Unknown protocol version: %s", error)
678
return
679
680
# Note: gnutls.connection.X509Credentials is really a generic
681
# GnuTLS certificate credentials object so long as no X.509
682
# keys are added to it. Therefore, we can use it here despite
683
# using OpenPGP certificates.
684
685
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
686
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
687
# "+DHE-DSS"))
688
# Use a fallback default, since this MUST be set.
689
priority = self.server.settings.get("priority", "NORMAL")
690
(gnutls.library.functions
691
.gnutls_priority_set_direct(session._c_object,
692
priority, None))
693
694
try:
695
session.handshake()
696
except gnutls.errors.GNUTLSError, error:
697
logger.warning(u"Handshake failed: %s", error)
698
# Do not run session.bye() here: the session is not
699
# established. Just abandon the request.
700
return
701
logger.debug(u"Handshake succeeded")
702
try:
703
fpr = fingerprint(peer_certificate(session))
704
except (TypeError, gnutls.errors.GNUTLSError), error:
705
logger.warning(u"Bad certificate: %s", error)
706
session.bye()
707
return
708
logger.debug(u"Fingerprint: %s", fpr)
709
710
for c in self.server.clients:
711
if c.fingerprint == fpr:
712
client = c
713
break
714
else:
715
logger.warning(u"Client not found for fingerprint: %s",
716
fpr)
717
session.bye()
718
return
719
# Have to check if client.still_valid(), since it is possible
720
# that the client timed out while establishing the GnuTLS
721
# session.
722
if not client.still_valid():
723
logger.warning(u"Client %(name)s is invalid",
724
vars(client))
725
session.bye()
726
return
727
## This won't work here, since we're in a fork.
728
# client.checked_ok()
729
sent_size = 0
730
while sent_size < len(client.secret):
731
sent = session.send(client.secret[sent_size:])
732
logger.debug(u"Sent: %d, remaining: %d",
733
sent, len(client.secret)
734
- (sent_size + sent))
735
sent_size += sent
736
session.bye()
737
738
739
class IPv6_TCPServer(SocketServer.ForkingMixIn,
740
SocketServer.TCPServer, object):
741
"""IPv6 TCP server. Accepts 'None' as address and/or port.
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
raise NotImplementedError
1413
1414
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1415
socketserver.TCPServer, object):
1416
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1417
742
1418
Attributes:
743
settings: Server settings
744
clients: Set() of Client objects
745
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
746
1422
"""
747
address_family = socket.AF_INET6
748
def __init__(self, *args, **kwargs):
749
if "settings" in kwargs:
750
self.settings = kwargs["settings"]
751
del kwargs["settings"]
752
if "clients" in kwargs:
753
self.clients = kwargs["clients"]
754
del kwargs["clients"]
755
self.enabled = False
756
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)
757
1430
def server_bind(self):
758
1431
"""This overrides the normal server_bind() function
759
1432
to bind to an interface if one was specified, and also NOT to
760
1433
bind to an address or port if they were not specified."""
761
if self.settings["interface"]:
762
# 25 is from /usr/include/asm-i486/socket.h
763
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
764
try:
765
self.socket.setsockopt(socket.SOL_SOCKET,
766
SO_BINDTODEVICE,
767
self.settings["interface"])
768
except socket.error, error:
769
if error[0] == errno.EPERM:
770
logger.error(u"No permission to"
771
u" bind to interface %s",
772
self.settings["interface"])
773
else:
774
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
775
1456
# Only bind(2) the socket if we really need to.
776
1457
if self.server_address[0] or self.server_address[1]:
777
1458
if not self.server_address[0]:
778
in6addr_any = "::"
779
self.server_address = (in6addr_any,
1459
if self.address_family == socket.AF_INET6:
1460
any_address = "::" # in6addr_any
1461
else:
1462
any_address = socket.INADDR_ANY
1463
self.server_address = (any_address,
780
1464
self.server_address[1])
781
1465
elif not self.server_address[1]:
782
1466
self.server_address = (self.server_address[0],
783
1467
0)
784
# if self.settings["interface"]:
1468
# if self.interface:
785
1469
# self.server_address = (self.server_address[0],
786
1470
# 0, # port
787
1471
# 0, # flowinfo
788
1472
# if_nametoindex
789
# (self.settings
790
# ["interface"]))
791
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)
792
1500
def server_activate(self):
793
1501
if self.enabled:
794
return super(IPv6_TCPServer, self).server_activate()
1502
return socketserver.TCPServer.server_activate(self)
795
1503
def enable(self):
796
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
797
1581
798
1582
799
1583
def string_to_delta(interval):
807
1591
datetime.timedelta(0, 3600)
808
1592
>>> string_to_delta('24h')
809
1593
datetime.timedelta(1)
810
>>> string_to_delta(u'1w')
1594
>>> string_to_delta('1w')
811
1595
datetime.timedelta(7)
812
1596
>>> string_to_delta('5m 30s')
813
1597
datetime.timedelta(0, 330)
817
1601
try:
818
1602
suffix = unicode(s[-1])
819
1603
value = int(s[:-1])
820
if suffix == u"d":
1604
if suffix == "d":
821
1605
delta = datetime.timedelta(value)
822
elif suffix == u"s":
1606
elif suffix == "s":
823
1607
delta = datetime.timedelta(0, value)
824
elif suffix == u"m":
1608
elif suffix == "m":
825
1609
delta = datetime.timedelta(0, 0, 0, 0, value)
826
elif suffix == u"h":
1610
elif suffix == "h":
827
1611
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
828
elif suffix == u"w":
1612
elif suffix == "w":
829
1613
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
830
1614
else:
831
raise ValueError
832
except (ValueError, IndexError):
833
raise ValueError
1615
raise ValueError("Unknown suffix %r" % suffix)
1616
except (ValueError, IndexError), e:
1617
raise ValueError(*(e.args))
834
1618
timevalue += delta
835
1619
return timevalue
836
1620
837
1621
838
def server_state_changed(state):
839
"""Derived from the Avahi example code"""
840
if state == avahi.SERVER_COLLISION:
841
logger.error(u"Zeroconf server name collision")
842
service.remove()
843
elif state == avahi.SERVER_RUNNING:
844
service.add()
845
846
847
def entry_group_state_changed(state, error):
848
"""Derived from the Avahi example code"""
849
logger.debug(u"Avahi state change: %i", state)
850
851
if state == avahi.ENTRY_GROUP_ESTABLISHED:
852
logger.debug(u"Zeroconf service established.")
853
elif state == avahi.ENTRY_GROUP_COLLISION:
854
logger.warning(u"Zeroconf service name collision.")
855
service.rename()
856
elif state == avahi.ENTRY_GROUP_FAILURE:
857
logger.critical(u"Avahi: Error in group state changed %s",
858
unicode(error))
859
raise AvahiGroupError(u"State changed: %s" % unicode(error))
860
861
1622
def if_nametoindex(interface):
862
"""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."""
863
1626
global if_nametoindex
864
1627
try:
865
1628
if_nametoindex = (ctypes.cdll.LoadLibrary
866
1629
(ctypes.util.find_library("c"))
867
1630
.if_nametoindex)
868
1631
except (OSError, AttributeError):
869
if "struct" not in sys.modules:
870
import struct
871
if "fcntl" not in sys.modules:
872
import fcntl
1632
logger.warning("Doing if_nametoindex the hard way")
873
1633
def if_nametoindex(interface):
874
1634
"Get an interface index the hard way, i.e. using fcntl()"
875
1635
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
876
with closing(socket.socket()) as s:
1636
with contextlib.closing(socket.socket()) as s:
877
1637
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
878
struct.pack("16s16x", interface))
879
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]
880
1642
return interface_index
881
1643
return if_nametoindex(interface)
882
1644
883
1645
884
1646
def daemon(nochdir = False, noclose = False):
885
1647
"""See daemon(3). Standard BSD Unix function.
1648
886
1649
This should really exist as os.daemon, but it doesn't (yet)."""
887
1650
if os.fork():
888
1651
sys.exit()
896
1659
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
897
1660
if not stat.S_ISCHR(os.fstat(null).st_mode):
898
1661
raise OSError(errno.ENODEV,
899
"/dev/null not a character device")
1662
"%s not a character device"
1663
% os.path.devnull)
900
1664
os.dup2(null, sys.stdin.fileno())
901
1665
os.dup2(null, sys.stdout.fileno())
902
1666
os.dup2(null, sys.stderr.fileno())
905
1669
906
1670
907
1671
def main():
908
parser = optparse.OptionParser(version = "%%prog %s" % version)
909
parser.add_option("-i", "--interface", type="string",
910
metavar="IF", help="Bind to interface IF")
911
parser.add_option("-a", "--address", type="string",
912
help="Address to listen for requests on")
913
parser.add_option("-p", "--port", type="int",
914
help="Port number to receive requests on")
915
parser.add_option("--check", action="store_true",
916
help="Run self-test")
917
parser.add_option("--debug", action="store_true",
918
help="Debug mode; run in foreground and log to"
919
" terminal")
920
parser.add_option("--priority", type="string", help="GnuTLS"
921
" priority string (see GnuTLS documentation)")
922
parser.add_option("--servicename", type="string", metavar="NAME",
923
help="Zeroconf service name")
924
parser.add_option("--configdir", type="string",
925
default="/etc/mandos", metavar="DIR",
926
help="Directory to search for configuration"
927
" files")
928
parser.add_option("--no-dbus", action="store_false",
929
dest="use_dbus",
930
help="Do not provide D-Bus system bus"
931
" interface")
932
options = parser.parse_args()[0]
1672
1673
##################################################################
1674
# Parsing of options, both command line and config file
1675
1676
parser = argparse.ArgumentParser()
1677
parser.add_argument("-v", "--version", action="version",
1678
version = "%%(prog)s %s" % version,
1679
help="show version number and exit")
1680
parser.add_argument("-i", "--interface", metavar="IF",
1681
help="Bind to interface IF")
1682
parser.add_argument("-a", "--address",
1683
help="Address to listen for requests on")
1684
parser.add_argument("-p", "--port", type=int,
1685
help="Port number to receive requests on")
1686
parser.add_argument("--check", action="store_true",
1687
help="Run self-test")
1688
parser.add_argument("--debug", action="store_true",
1689
help="Debug mode; run in foreground and log"
1690
" to terminal")
1691
parser.add_argument("--debuglevel", metavar="LEVEL",
1692
help="Debug level for stdout output")
1693
parser.add_argument("--priority", help="GnuTLS"
1694
" priority string (see GnuTLS documentation)")
1695
parser.add_argument("--servicename",
1696
metavar="NAME", help="Zeroconf service name")
1697
parser.add_argument("--configdir",
1698
default="/etc/mandos", metavar="DIR",
1699
help="Directory to search for configuration"
1700
" files")
1701
parser.add_argument("--no-dbus", action="store_false",
1702
dest="use_dbus", help="Do not provide D-Bus"
1703
" system bus interface")
1704
parser.add_argument("--no-ipv6", action="store_false",
1705
dest="use_ipv6", help="Do not use IPv6")
1706
options = parser.parse_args()
933
1707
934
1708
if options.check:
935
1709
import doctest
945
1719
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
946
1720
"servicename": "Mandos",
947
1721
"use_dbus": "True",
1722
"use_ipv6": "True",
1723
"debuglevel": "",
948
1724
}
949
1725
950
1726
# Parse config file for server-global settings
951
server_config = ConfigParser.SafeConfigParser(server_defaults)
1727
server_config = configparser.SafeConfigParser(server_defaults)
952
1728
del server_defaults
953
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1729
server_config.read(os.path.join(options.configdir,
1730
"mandos.conf"))
954
1731
# Convert the SafeConfigParser object to a dict
955
1732
server_settings = server_config.defaults()
956
1733
# Use the appropriate methods on the non-string config options
957
server_settings["debug"] = server_config.getboolean("DEFAULT",
958
"debug")
959
server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
960
"use_dbus")
1734
for option in ("debug", "use_dbus", "use_ipv6"):
1735
server_settings[option] = server_config.getboolean("DEFAULT",
1736
option)
961
1737
if server_settings["port"]:
962
1738
server_settings["port"] = server_config.getint("DEFAULT",
963
1739
"port")
967
1743
# options, if set.
968
1744
for option in ("interface", "address", "port", "debug",
969
1745
"priority", "servicename", "configdir",
970
"use_dbus"):
1746
"use_dbus", "use_ipv6", "debuglevel"):
971
1747
value = getattr(options, option)
972
1748
if value is not None:
973
1749
server_settings[option] = value
974
1750
del options
1751
# Force all strings to be unicode
1752
for option in server_settings.keys():
1753
if type(server_settings[option]) is str:
1754
server_settings[option] = unicode(server_settings[option])
975
1755
# Now we have our good server settings in "server_settings"
976
1756
1757
##################################################################
1758
977
1759
# For convenience
978
1760
debug = server_settings["debug"]
1761
debuglevel = server_settings["debuglevel"]
979
1762
use_dbus = server_settings["use_dbus"]
980
981
if not debug:
982
syslogger.setLevel(logging.WARNING)
983
console.setLevel(logging.WARNING)
984
1763
use_ipv6 = server_settings["use_ipv6"]
1764
985
1765
if server_settings["servicename"] != "Mandos":
986
1766
syslogger.setFormatter(logging.Formatter
987
('Mandos (%s): %%(levelname)s:'
988
' %%(message)s'
1767
('Mandos (%s) [%%(process)d]:'
1768
' %%(levelname)s: %%(message)s'
989
1769
% server_settings["servicename"]))
990
1770
991
1771
# Parse config file with clients
993
1773
"interval": "5m",
994
1774
"checker": "fping -q -- %%(host)s",
995
1775
"host": "",
1776
"approval_delay": "0s",
1777
"approval_duration": "1s",
996
1778
}
997
client_config = ConfigParser.SafeConfigParser(client_defaults)
1779
client_config = configparser.SafeConfigParser(client_defaults)
998
1780
client_config.read(os.path.join(server_settings["configdir"],
999
1781
"clients.conf"))
1000
1782
1001
clients = Set()
1002
tcp_server = IPv6_TCPServer((server_settings["address"],
1003
server_settings["port"]),
1004
TCP_handler,
1005
settings=server_settings,
1006
clients=clients)
1007
pidfilename = "/var/run/mandos.pid"
1008
try:
1009
pidfile = open(pidfilename, "w")
1010
except IOError:
1011
logger.error("Could not open file %r", pidfilename)
1783
global mandos_dbus_service
1784
mandos_dbus_service = None
1785
1786
tcp_server = MandosServer((server_settings["address"],
1787
server_settings["port"]),
1788
ClientHandler,
1789
interface=(server_settings["interface"]
1790
or None),
1791
use_ipv6=use_ipv6,
1792
gnutls_priority=
1793
server_settings["priority"],
1794
use_dbus=use_dbus)
1795
if not debug:
1796
pidfilename = "/var/run/mandos.pid"
1797
try:
1798
pidfile = open(pidfilename, "w")
1799
except IOError:
1800
logger.error("Could not open file %r", pidfilename)
1012
1801
1013
1802
try:
1014
1803
uid = pwd.getpwnam("_mandos").pw_uid
1020
1809
except KeyError:
1021
1810
try:
1022
1811
uid = pwd.getpwnam("nobody").pw_uid
1023
gid = pwd.getpwnam("nogroup").pw_gid
1812
gid = pwd.getpwnam("nobody").pw_gid
1024
1813
except KeyError:
1025
1814
uid = 65534
1026
1815
gid = 65534
1031
1820
if error[0] != errno.EPERM:
1032
1821
raise error
1033
1822
1034
# Enable all possible GnuTLS debugging
1823
if not debug and not debuglevel:
1824
syslogger.setLevel(logging.WARNING)
1825
console.setLevel(logging.WARNING)
1826
if debuglevel:
1827
level = getattr(logging, debuglevel.upper())
1828
syslogger.setLevel(level)
1829
console.setLevel(level)
1830
1035
1831
if debug:
1832
# Enable all possible GnuTLS debugging
1833
1036
1834
# "Use a log level over 10 to enable all debugging options."
1037
1835
# - GnuTLS manual
1038
1836
gnutls.library.functions.gnutls_global_set_log_level(11)
1043
1841
1044
1842
(gnutls.library.functions
1045
1843
.gnutls_global_set_log_function(debug_gnutls))
1844
1845
# Redirect stdin so all checkers get /dev/null
1846
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1847
os.dup2(null, sys.stdin.fileno())
1848
if null > 2:
1849
os.close(null)
1850
else:
1851
# No console logging
1852
logger.removeHandler(console)
1046
1853
1047
global service
1048
service = AvahiService(name = server_settings["servicename"],
1049
servicetype = "_mandos._tcp", )
1050
if server_settings["interface"]:
1051
service.interface = (if_nametoindex
1052
(server_settings["interface"]))
1854
# Need to fork before connecting to D-Bus
1855
if not debug:
1856
# Close all input and output, do double fork, etc.
1857
daemon()
1053
1858
1054
1859
global main_loop
1055
global bus
1056
global server
1057
1860
# From the Avahi example code
1058
1861
DBusGMainLoop(set_as_default=True )
1059
1862
main_loop = gobject.MainLoop()
1060
1863
bus = dbus.SystemBus()
1061
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1062
avahi.DBUS_PATH_SERVER),
1063
avahi.DBUS_INTERFACE_SERVER)
1064
1864
# End of Avahi example code
1065
1865
if use_dbus:
1066
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1067
1068
clients.update(Set(Client(name = section,
1069
config
1070
= dict(client_config.items(section)),
1071
use_dbus = use_dbus)
1072
for section in client_config.sections()))
1073
if not clients:
1074
logger.warning(u"No clients defined")
1075
1076
if debug:
1077
# Redirect stdin so all checkers get /dev/null
1078
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1079
os.dup2(null, sys.stdin.fileno())
1080
if null > 2:
1081
os.close(null)
1082
else:
1083
# No console logging
1084
logger.removeHandler(console)
1085
# Close all input and output, do double fork, etc.
1086
daemon()
1087
1088
try:
1089
pid = os.getpid()
1090
pidfile.write(str(pid) + "\n")
1091
pidfile.close()
1092
del pidfile
1093
except IOError:
1094
logger.error(u"Could not write to file %r with PID %d",
1095
pidfilename, pid)
1096
except NameError:
1097
# "pidfile" was never created
1098
pass
1099
del pidfilename
1100
1101
def cleanup():
1102
"Cleanup function; run on exit"
1103
global group
1104
# From the Avahi example code
1105
if not group is None:
1106
group.Free()
1107
group = None
1108
# End of Avahi example code
1866
try:
1867
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1868
bus, do_not_queue=True)
1869
except dbus.exceptions.NameExistsException, e:
1870
logger.error(unicode(e) + ", disabling D-Bus")
1871
use_dbus = False
1872
server_settings["use_dbus"] = False
1873
tcp_server.use_dbus = False
1874
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1875
service = AvahiService(name = server_settings["servicename"],
1876
servicetype = "_mandos._tcp",
1877
protocol = protocol, bus = bus)
1878
if server_settings["interface"]:
1879
service.interface = (if_nametoindex
1880
(str(server_settings["interface"])))
1881
1882
global multiprocessing_manager
1883
multiprocessing_manager = multiprocessing.Manager()
1884
1885
client_class = Client
1886
if use_dbus:
1887
client_class = functools.partial(ClientDBus, bus = bus)
1888
def client_config_items(config, section):
1889
special_settings = {
1890
"approved_by_default":
1891
lambda: config.getboolean(section,
1892
"approved_by_default"),
1893
}
1894
for name, value in config.items(section):
1895
try:
1896
yield (name, special_settings[name]())
1897
except KeyError:
1898
yield (name, value)
1899
1900
tcp_server.clients.update(set(
1901
client_class(name = section,
1902
config= dict(client_config_items(
1903
client_config, section)))
1904
for section in client_config.sections()))
1905
if not tcp_server.clients:
1906
logger.warning("No clients defined")
1109
1907
1110
while clients:
1111
client = clients.pop()
1112
client.disable_hook = None
1113
client.disable()
1114
1115
atexit.register(cleanup)
1116
1117
1908
if not debug:
1909
try:
1910
with pidfile:
1911
pid = os.getpid()
1912
pidfile.write(str(pid) + "\n".encode("utf-8"))
1913
del pidfile
1914
except IOError:
1915
logger.error("Could not write to file %r with PID %d",
1916
pidfilename, pid)
1917
except NameError:
1918
# "pidfile" was never created
1919
pass
1920
del pidfilename
1921
1118
1922
signal.signal(signal.SIGINT, signal.SIG_IGN)
1923
1119
1924
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1120
1925
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1121
1926
1122
1927
if use_dbus:
1123
class MandosServer(dbus.service.Object):
1928
class MandosDBusService(dbus.service.Object):
1124
1929
"""A D-Bus proxy object"""
1125
1930
def __init__(self):
1126
1931
dbus.service.Object.__init__(self, bus, "/")
1127
_interface = u"se.bsnet.fukt.Mandos"
1128
1129
@dbus.service.signal(_interface, signature="oa{sv}")
1130
def ClientAdded(self, objpath, properties):
1932
_interface = "se.bsnet.fukt.Mandos"
1933
1934
@dbus.service.signal(_interface, signature="o")
1935
def ClientAdded(self, objpath):
1936
"D-Bus signal"
1937
pass
1938
1939
@dbus.service.signal(_interface, signature="ss")
1940
def ClientNotFound(self, fingerprint, address):
1131
1941
"D-Bus signal"
1132
1942
pass
1133
1943
1139
1949
@dbus.service.method(_interface, out_signature="ao")
1140
1950
def GetAllClients(self):
1141
1951
"D-Bus method"
1142
return dbus.Array(c.dbus_object_path for c in clients)
1952
return dbus.Array(c.dbus_object_path
1953
for c in tcp_server.clients)
1143
1954
1144
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
1955
@dbus.service.method(_interface,
1956
out_signature="a{oa{sv}}")
1145
1957
def GetAllClientsWithProperties(self):
1146
1958
"D-Bus method"
1147
1959
return dbus.Dictionary(
1148
((c.dbus_object_path, c.GetAllProperties())
1149
for c in clients),
1960
((c.dbus_object_path, c.GetAll(""))
1961
for c in tcp_server.clients),
1150
1962
signature="oa{sv}")
1151
1963
1152
1964
@dbus.service.method(_interface, in_signature="o")
1153
1965
def RemoveClient(self, object_path):
1154
1966
"D-Bus method"
1155
for c in clients:
1967
for c in tcp_server.clients:
1156
1968
if c.dbus_object_path == object_path:
1157
clients.remove(c)
1969
tcp_server.clients.remove(c)
1970
c.remove_from_connection()
1158
1971
# Don't signal anything except ClientRemoved
1159
c.use_dbus = False
1160
c.disable()
1972
c.disable(quiet=True)
1161
1973
# Emit D-Bus signal
1162
1974
self.ClientRemoved(object_path, c.name)
1163
1975
return
1164
raise KeyError
1976
raise KeyError(object_path)
1165
1977
1166
1978
del _interface
1167
1979
1168
mandos_server = MandosServer()
1169
1170
for client in clients:
1980
mandos_dbus_service = MandosDBusService()
1981
1982
def cleanup():
1983
"Cleanup function; run on exit"
1984
service.cleanup()
1985
1986
while tcp_server.clients:
1987
client = tcp_server.clients.pop()
1988
if use_dbus:
1989
client.remove_from_connection()
1990
client.disable_hook = None
1991
# Don't signal anything except ClientRemoved
1992
client.disable(quiet=True)
1993
if use_dbus:
1994
# Emit D-Bus signal
1995
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1996
client.name)
1997
1998
atexit.register(cleanup)
1999
2000
for client in tcp_server.clients:
1171
2001
if use_dbus:
1172
2002
# Emit D-Bus signal
1173
mandos_server.ClientAdded(client.dbus_object_path,
1174
client.GetAllProperties())
2003
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1175
2004
client.enable()
1176
2005
1177
2006
tcp_server.enable()
1179
2008
1180
2009
# Find out what port we got
1181
2010
service.port = tcp_server.socket.getsockname()[1]
1182
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
1183
u" scope_id %d" % tcp_server.socket.getsockname())
2011
if use_ipv6:
2012
logger.info("Now listening on address %r, port %d,"
2013
" flowinfo %d, scope_id %d"
2014
% tcp_server.socket.getsockname())
2015
else: # IPv4
2016
logger.info("Now listening on address %r, port %d"
2017
% tcp_server.socket.getsockname())
1184
2018
1185
2019
#service.interface = tcp_server.socket.getsockname()[3]
1186
2020
1187
2021
try:
1188
2022
# From the Avahi example code
1189
server.connect_to_signal("StateChanged", server_state_changed)
1190
2023
try:
1191
server_state_changed(server.GetState())
2024
service.activate()
1192
2025
except dbus.exceptions.DBusException, error:
1193
logger.critical(u"DBusException: %s", error)
2026
logger.critical("DBusException: %s", error)
2027
cleanup()
1194
2028
sys.exit(1)
1195
2029
# End of Avahi example code
1196
2030
1199
2033
(tcp_server.handle_request
1200
2034
(*args[2:], **kwargs) or True))
1201
2035
1202
logger.debug(u"Starting main loop")
2036
logger.debug("Starting main loop")
1203
2037
main_loop.run()
1204
2038
except AvahiError, error:
1205
logger.critical(u"AvahiError: %s", error)
2039
logger.critical("AvahiError: %s", error)
2040
cleanup()
1206
2041
sys.exit(1)
1207
2042
except KeyboardInterrupt:
1208
2043
if debug:
1209
print >> sys.stderr
2044
print("", file=sys.stderr)
1210
2045
logger.debug("Server received KeyboardInterrupt")
1211
2046
logger.debug("Server exiting")
2047
# Must run before the D-Bus bus name gets deregistered
2048
cleanup()
1212
2049
1213
2050
if __name__ == '__main__':
1214
2051
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0