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