To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 24.2.1
- compare with another revision
- download diff
- download tarball
- view history from revision 24.2.1
- Committer: teddy at bsnet
- Date: 2010-08-23 19:23:15 UTC
- mto: (24.1.154 mandos)
- mto: This revision was merged to the branch mainline in revision 421.
- Revision ID: teddy@fukt.bsnet.se-20100823192315-pefgye0l6cavcejs
* debian/control (mandos/Depends): Added "python-urwid".
* mandos (Client.approved_by_default): Changed default to "True".
(Client.approved_delay): Changed default to "0s".
(ClientDBus.GotSecret, ClientDBus.Rejected,
ClientDBus.NeedApproval): Emit "PropertyChanged" signal for the
"approved_pending" property.
* mandos (Client.approved_by_default): Changed default to "True".
(Client.approved_delay): Changed default to "0s".
(ClientDBus.GotSecret, ClientDBus.Rejected,
ClientDBus.NeedApproval): Emit "PropertyChanged" signal for the
"approved_pending" property.
- files removed:
- DBUS-API
- debian/source
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 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
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@recompile.se>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
34
from __future__ import division, with_statement, absolute_import
36
35
37
36
import SocketServer as socketserver
38
37
import socket
39
import argparse
38
import optparse
40
39
import datetime
41
40
import errno
42
41
import gnutls.crypto
62
61
import functools
63
62
import cPickle as pickle
64
63
import multiprocessing
65
import types
66
import binascii
67
import tempfile
68
import itertools
69
64
70
65
import dbus
71
66
import dbus.service
76
71
import ctypes.util
77
72
import xml.dom.minidom
78
73
import inspect
79
import GnuPGInterface
80
74
81
75
try:
82
76
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
80
except ImportError:
87
81
SO_BINDTODEVICE = None
88
82
89
version = "1.5.3"
90
stored_state_file = "clients.pickle"
91
92
logger = logging.getLogger()
83
84
version = "1.0.14"
85
86
logger = logging.Logger(u'mandos')
93
87
syslogger = (logging.handlers.SysLogHandler
94
88
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
96
97
try:
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
100
.if_nametoindex)
101
except (OSError, AttributeError):
102
def if_nametoindex(interface):
103
"Get an interface index the hard way, i.e. using fcntl()"
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
with contextlib.closing(socket.socket()) as s:
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
108
interface))
109
interface_index = struct.unpack(str("I"),
110
ifreq[16:20])[0]
111
return interface_index
112
113
114
def initlogger(debug, level=logging.WARNING):
115
"""init logger and add loglevel"""
116
117
syslogger.setFormatter(logging.Formatter
118
('Mandos [%(process)d]: %(levelname)s:'
119
' %(message)s'))
120
logger.addHandler(syslogger)
121
122
if debug:
123
console = logging.StreamHandler()
124
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
125
' [%(process)d]:'
126
' %(levelname)s:'
127
' %(message)s'))
128
logger.addHandler(console)
129
logger.setLevel(level)
130
131
132
class PGPError(Exception):
133
"""Exception if encryption/decryption fails"""
134
pass
135
136
137
class PGPEngine(object):
138
"""A simple class for OpenPGP symmetric encryption & decryption"""
139
def __init__(self):
140
self.gnupg = GnuPGInterface.GnuPG()
141
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
142
self.gnupg = GnuPGInterface.GnuPG()
143
self.gnupg.options.meta_interactive = False
144
self.gnupg.options.homedir = self.tempdir
145
self.gnupg.options.extra_args.extend(['--force-mdc',
146
'--quiet',
147
'--no-use-agent'])
148
149
def __enter__(self):
150
return self
151
152
def __exit__ (self, exc_type, exc_value, traceback):
153
self._cleanup()
154
return False
155
156
def __del__(self):
157
self._cleanup()
158
159
def _cleanup(self):
160
if self.tempdir is not None:
161
# Delete contents of tempdir
162
for root, dirs, files in os.walk(self.tempdir,
163
topdown = False):
164
for filename in files:
165
os.remove(os.path.join(root, filename))
166
for dirname in dirs:
167
os.rmdir(os.path.join(root, dirname))
168
# Remove tempdir
169
os.rmdir(self.tempdir)
170
self.tempdir = None
171
172
def password_encode(self, password):
173
# Passphrase can not be empty and can not contain newlines or
174
# NUL bytes. So we prefix it and hex encode it.
175
return b"mandos" + binascii.hexlify(password)
176
177
def encrypt(self, data, password):
178
self.gnupg.passphrase = self.password_encode(password)
179
with open(os.devnull, "w") as devnull:
180
try:
181
proc = self.gnupg.run(['--symmetric'],
182
create_fhs=['stdin', 'stdout'],
183
attach_fhs={'stderr': devnull})
184
with contextlib.closing(proc.handles['stdin']) as f:
185
f.write(data)
186
with contextlib.closing(proc.handles['stdout']) as f:
187
ciphertext = f.read()
188
proc.wait()
189
except IOError as e:
190
raise PGPError(e)
191
self.gnupg.passphrase = None
192
return ciphertext
193
194
def decrypt(self, data, password):
195
self.gnupg.passphrase = self.password_encode(password)
196
with open(os.devnull, "w") as devnull:
197
try:
198
proc = self.gnupg.run(['--decrypt'],
199
create_fhs=['stdin', 'stdout'],
200
attach_fhs={'stderr': devnull})
201
with contextlib.closing(proc.handles['stdin']) as f:
202
f.write(data)
203
with contextlib.closing(proc.handles['stdout']) as f:
204
decrypted_plaintext = f.read()
205
proc.wait()
206
except IOError as e:
207
raise PGPError(e)
208
self.gnupg.passphrase = None
209
return decrypted_plaintext
210
89
address = "/dev/log"))
90
syslogger.setFormatter(logging.Formatter
91
(u'Mandos [%(process)d]: %(levelname)s:'
92
u' %(message)s'))
93
logger.addHandler(syslogger)
94
95
console = logging.StreamHandler()
96
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
97
u' %(levelname)s:'
98
u' %(message)s'))
99
logger.addHandler(console)
100
101
multiprocessing_manager = multiprocessing.Manager()
211
102
212
103
class AvahiError(Exception):
213
104
def __init__(self, value, *args, **kwargs):
229
120
Attributes:
230
121
interface: integer; avahi.IF_UNSPEC or an interface index.
231
122
Used to optionally bind to the specified interface.
232
name: string; Example: 'Mandos'
233
type: string; Example: '_mandos._tcp'.
123
name: string; Example: u'Mandos'
124
type: string; Example: u'_mandos._tcp'.
234
125
See <http://www.dns-sd.org/ServiceTypes.html>
235
126
port: integer; what port to announce
236
127
TXT: list of strings; TXT record for the service
243
134
server: D-Bus Server
244
135
bus: dbus.SystemBus()
245
136
"""
246
247
137
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
248
138
servicetype = None, port = None, TXT = None,
249
domain = "", host = "", max_renames = 32768,
139
domain = u"", host = u"", max_renames = 32768,
250
140
protocol = avahi.PROTO_UNSPEC, bus = None):
251
141
self.interface = interface
252
142
self.name = name
261
151
self.group = None # our entry group
262
152
self.server = None
263
153
self.bus = bus
264
self.entry_group_state_changed_match = None
265
266
154
def rename(self):
267
155
"""Derived from the Avahi example code"""
268
156
if self.rename_count >= self.max_renames:
269
logger.critical("No suitable Zeroconf service name found"
270
" after %i retries, exiting.",
157
logger.critical(u"No suitable Zeroconf service name found"
158
u" after %i retries, exiting.",
271
159
self.rename_count)
272
raise AvahiServiceError("Too many renames")
273
self.name = unicode(self.server
274
.GetAlternativeServiceName(self.name))
275
logger.info("Changing Zeroconf service name to %r ...",
276
self.name)
160
raise AvahiServiceError(u"Too many renames")
161
self.name = self.server.GetAlternativeServiceName(self.name)
162
logger.info(u"Changing Zeroconf service name to %r ...",
163
unicode(self.name))
164
syslogger.setFormatter(logging.Formatter
165
(u'Mandos (%s) [%%(process)d]:'
166
u' %%(levelname)s: %%(message)s'
167
% self.name))
277
168
self.remove()
278
try:
279
self.add()
280
except dbus.exceptions.DBusException as error:
281
logger.critical("D-Bus Exception", exc_info=error)
282
self.cleanup()
283
os._exit(1)
169
self.add()
284
170
self.rename_count += 1
285
286
171
def remove(self):
287
172
"""Derived from the Avahi example code"""
288
if self.entry_group_state_changed_match is not None:
289
self.entry_group_state_changed_match.remove()
290
self.entry_group_state_changed_match = None
291
173
if self.group is not None:
292
174
self.group.Reset()
293
294
175
def add(self):
295
176
"""Derived from the Avahi example code"""
296
self.remove()
297
177
if self.group is None:
298
178
self.group = dbus.Interface(
299
179
self.bus.get_object(avahi.DBUS_NAME,
300
180
self.server.EntryGroupNew()),
301
181
avahi.DBUS_INTERFACE_ENTRY_GROUP)
302
self.entry_group_state_changed_match = (
303
self.group.connect_to_signal(
304
'StateChanged', self.entry_group_state_changed))
305
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
182
self.group.connect_to_signal('StateChanged',
183
self
184
.entry_group_state_changed)
185
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
306
186
self.name, self.type)
307
187
self.group.AddService(
308
188
self.interface,
313
193
dbus.UInt16(self.port),
314
194
avahi.string_array_to_txt_array(self.TXT))
315
195
self.group.Commit()
316
317
196
def entry_group_state_changed(self, state, error):
318
197
"""Derived from the Avahi example code"""
319
logger.debug("Avahi entry group state change: %i", state)
198
logger.debug(u"Avahi state change: %i", state)
320
199
321
200
if state == avahi.ENTRY_GROUP_ESTABLISHED:
322
logger.debug("Zeroconf service established.")
201
logger.debug(u"Zeroconf service established.")
323
202
elif state == avahi.ENTRY_GROUP_COLLISION:
324
logger.info("Zeroconf service name collision.")
203
logger.warning(u"Zeroconf service name collision.")
325
204
self.rename()
326
205
elif state == avahi.ENTRY_GROUP_FAILURE:
327
logger.critical("Avahi: Error in group state changed %s",
206
logger.critical(u"Avahi: Error in group state changed %s",
328
207
unicode(error))
329
raise AvahiGroupError("State changed: {0!s}"
330
.format(error))
331
208
raise AvahiGroupError(u"State changed: %s"
209
% unicode(error))
332
210
def cleanup(self):
333
211
"""Derived from the Avahi example code"""
334
212
if self.group is not None:
335
try:
336
self.group.Free()
337
except (dbus.exceptions.UnknownMethodException,
338
dbus.exceptions.DBusException):
339
pass
213
self.group.Free()
340
214
self.group = None
341
self.remove()
342
343
def server_state_changed(self, state, error=None):
215
def server_state_changed(self, state):
344
216
"""Derived from the Avahi example code"""
345
logger.debug("Avahi server state change: %i", state)
346
bad_states = { avahi.SERVER_INVALID:
347
"Zeroconf server invalid",
348
avahi.SERVER_REGISTERING: None,
349
avahi.SERVER_COLLISION:
350
"Zeroconf server name collision",
351
avahi.SERVER_FAILURE:
352
"Zeroconf server failure" }
353
if state in bad_states:
354
if bad_states[state] is not None:
355
if error is None:
356
logger.error(bad_states[state])
357
else:
358
logger.error(bad_states[state] + ": %r", error)
359
self.cleanup()
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
219
self.remove()
360
220
elif state == avahi.SERVER_RUNNING:
361
221
self.add()
362
else:
363
if error is None:
364
logger.debug("Unknown state: %r", state)
365
else:
366
logger.debug("Unknown state: %r: %r", state, error)
367
368
222
def activate(self):
369
223
"""Derived from the Avahi example code"""
370
224
if self.server is None:
371
225
self.server = dbus.Interface(
372
226
self.bus.get_object(avahi.DBUS_NAME,
373
avahi.DBUS_PATH_SERVER,
374
follow_name_owner_changes=True),
227
avahi.DBUS_PATH_SERVER),
375
228
avahi.DBUS_INTERFACE_SERVER)
376
self.server.connect_to_signal("StateChanged",
229
self.server.connect_to_signal(u"StateChanged",
377
230
self.server_state_changed)
378
231
self.server_state_changed(self.server.GetState())
379
232
380
class AvahiServiceToSyslog(AvahiService):
381
def rename(self):
382
"""Add the new name to the syslog messages"""
383
ret = AvahiService.rename(self)
384
syslogger.setFormatter(logging.Formatter
385
('Mandos ({0}) [%(process)d]:'
386
' %(levelname)s: %(message)s'
387
.format(self.name)))
388
return ret
389
390
def timedelta_to_milliseconds(td):
391
"Convert a datetime.timedelta() to milliseconds"
392
return ((td.days * 24 * 60 * 60 * 1000)
393
+ (td.seconds * 1000)
394
+ (td.microseconds // 1000))
395
233
396
234
class Client(object):
397
235
"""A representation of a client host served by this server.
398
236
399
237
Attributes:
400
approved: bool(); 'None' if not yet approved/disapproved
401
approval_delay: datetime.timedelta(); Time to wait for approval
402
approval_duration: datetime.timedelta(); Duration of one approval
238
name: string; from the config file, used in log messages and
239
D-Bus identifiers
240
fingerprint: string (40 or 32 hexadecimal digits); used to
241
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
host: string; available for use by the checker command
244
created: datetime.datetime(); (UTC) object creation
245
last_enabled: datetime.datetime(); (UTC)
246
enabled: bool()
247
last_checked_ok: datetime.datetime(); (UTC) or None
248
timeout: datetime.timedelta(); How long from last_checked_ok
249
until this client is disabled
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
403
252
checker: subprocess.Popen(); a running checker process used
404
253
to see if the client lives.
405
254
'None' if no process is running.
406
checker_callback_tag: a gobject event source tag, or None
407
checker_command: string; External command which is run to check
408
if client lives. %() expansions are done at
255
checker_initiator_tag: a gobject event source tag, or None
256
disable_initiator_tag: - '' -
257
checker_callback_tag: - '' -
258
checker_command: string; External command which is run to check if
259
client lives. %() expansions are done at
409
260
runtime with vars(self) as dict, so that for
410
261
instance %(name)s can be used in the command.
411
checker_initiator_tag: a gobject event source tag, or None
412
created: datetime.datetime(); (UTC) object creation
413
client_structure: Object describing what attributes a client has
414
and is used for storing the client at exit
415
262
current_checker_command: string; current running checker_command
416
disable_initiator_tag: a gobject event source tag, or None
417
enabled: bool()
418
fingerprint: string (40 or 32 hexadecimal digits); used to
419
uniquely identify the client
420
host: string; available for use by the checker command
421
interval: datetime.timedelta(); How often to start a new checker
422
last_approval_request: datetime.datetime(); (UTC) or None
423
last_checked_ok: datetime.datetime(); (UTC) or None
424
last_checker_status: integer between 0 and 255 reflecting exit
425
status of last checker. -1 reflects crashed
426
checker, -2 means no checker completed yet.
427
last_enabled: datetime.datetime(); (UTC) or None
428
name: string; from the config file, used in log messages and
429
D-Bus identifiers
430
secret: bytestring; sent verbatim (over TLS) to client
431
timeout: datetime.timedelta(); How long from last_checked_ok
432
until this client is disabled
433
extended_timeout: extra long timeout when secret has been sent
434
runtime_expansions: Allowed attributes for runtime expansion.
435
expires: datetime.datetime(); time (UTC) when a client will be
436
disabled, or None
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
437
266
"""
438
267
439
runtime_expansions = ("approval_delay", "approval_duration",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
442
"last_enabled", "name", "timeout")
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
445
"interval": "2m",
446
"checker": "fping -q -- %%(host)s",
447
"host": "",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
450
"approved_by_default": "True",
451
"enabled": "True",
452
}
268
@staticmethod
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
453
274
454
275
def timeout_milliseconds(self):
455
276
"Return the 'timeout' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.timeout)
457
458
def extended_timeout_milliseconds(self):
459
"Return the 'extended_timeout' attribute in milliseconds"
460
return timedelta_to_milliseconds(self.extended_timeout)
277
return self._timedelta_to_milliseconds(self.timeout)
461
278
462
279
def interval_milliseconds(self):
463
280
"Return the 'interval' attribute in milliseconds"
464
return timedelta_to_milliseconds(self.interval)
465
466
def approval_delay_milliseconds(self):
467
return timedelta_to_milliseconds(self.approval_delay)
468
469
@staticmethod
470
def config_parser(config):
471
"""Construct a new dict of client settings of this form:
472
{ client_name: {setting_name: value, ...}, ...}
473
with exceptions for any special settings as defined above.
474
NOTE: Must be a pure function. Must return the same result
475
value given the same arguments.
476
"""
477
settings = {}
478
for client_name in config.sections():
479
section = dict(config.items(client_name))
480
client = settings[client_name] = {}
481
482
client["host"] = section["host"]
483
# Reformat values from string types to Python types
484
client["approved_by_default"] = config.getboolean(
485
client_name, "approved_by_default")
486
client["enabled"] = config.getboolean(client_name,
487
"enabled")
488
489
client["fingerprint"] = (section["fingerprint"].upper()
490
.replace(" ", ""))
491
if "secret" in section:
492
client["secret"] = section["secret"].decode("base64")
493
elif "secfile" in section:
494
with open(os.path.expanduser(os.path.expandvars
495
(section["secfile"])),
496
"rb") as secfile:
497
client["secret"] = secfile.read()
498
else:
499
raise TypeError("No secret or secfile for section {0}"
500
.format(section))
501
client["timeout"] = string_to_delta(section["timeout"])
502
client["extended_timeout"] = string_to_delta(
503
section["extended_timeout"])
504
client["interval"] = string_to_delta(section["interval"])
505
client["approval_delay"] = string_to_delta(
506
section["approval_delay"])
507
client["approval_duration"] = string_to_delta(
508
section["approval_duration"])
509
client["checker_command"] = section["checker"]
510
client["last_approval_request"] = None
511
client["last_checked_ok"] = None
512
client["last_checker_status"] = -2
513
514
return settings
515
516
def __init__(self, settings, name = None):
281
return self._timedelta_to_milliseconds(self.interval)
282
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
285
286
def __init__(self, name = None, disable_hook=None, config=None):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
289
attribute."""
517
290
self.name = name
518
# adding all client settings
519
for setting, value in settings.iteritems():
520
setattr(self, setting, value)
521
522
if self.enabled:
523
if not hasattr(self, "last_enabled"):
524
self.last_enabled = datetime.datetime.utcnow()
525
if not hasattr(self, "expires"):
526
self.expires = (datetime.datetime.utcnow()
527
+ self.timeout)
528
else:
529
self.last_enabled = None
530
self.expires = None
531
532
logger.debug("Creating client %r", self.name)
291
if config is None:
292
config = {}
293
logger.debug(u"Creating client %r", self.name)
533
294
# Uppercase and remove spaces from fingerprint for later
534
295
# comparison purposes with return value from the fingerprint()
535
296
# function
536
logger.debug(" Fingerprint: %s", self.fingerprint)
537
self.created = settings.get("created",
538
datetime.datetime.utcnow())
539
540
# attributes specific for this server instance
297
self.fingerprint = (config[u"fingerprint"].upper()
298
.replace(u" ", u""))
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
305
"rb") as secfile:
306
self.secret = secfile.read()
307
else:
308
#XXX Need to allow secret on demand!
309
raise TypeError(u"No secret or secfile for client %s"
310
% self.name)
311
self.host = config.get(u"host", u"")
312
self.created = datetime.datetime.utcnow()
313
self.enabled = False
314
self.last_enabled = None
315
self.last_checked_ok = None
316
self.timeout = string_to_delta(config[u"timeout"])
317
self.interval = string_to_delta(config[u"interval"])
318
self.disable_hook = disable_hook
541
319
self.checker = None
542
320
self.checker_initiator_tag = None
543
321
self.disable_initiator_tag = None
544
322
self.checker_callback_tag = None
323
self.checker_command = config[u"checker"]
545
324
self.current_checker_command = None
546
self.approved = None
325
self.last_connect = None
547
326
self.approvals_pending = 0
548
self.changedstate = (multiprocessing_manager
549
.Condition(multiprocessing_manager
550
.Lock()))
551
self.client_structure = [attr for attr in
552
self.__dict__.iterkeys()
553
if not attr.startswith("_")]
554
self.client_structure.append("client_structure")
555
556
for name, t in inspect.getmembers(type(self),
557
lambda obj:
558
isinstance(obj,
559
property)):
560
if not name.startswith("_"):
561
self.client_structure.append(name)
562
563
# Send notice to process children that client state has changed
327
self._approved = None
328
self.approved_by_default = config.get(u"approved_by_default",
329
True)
330
self.approved_delay = string_to_delta(
331
config[u"approved_delay"])
332
self.approved_duration = string_to_delta(
333
config[u"approved_duration"])
334
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
335
564
336
def send_changedstate(self):
565
with self.changedstate:
566
self.changedstate.notify_all()
567
337
self.changedstate.acquire()
338
self.changedstate.notify_all()
339
self.changedstate.release()
340
568
341
def enable(self):
569
342
"""Start this client's checker and timeout hooks"""
570
if getattr(self, "enabled", False):
343
if getattr(self, u"enabled", False):
571
344
# Already enabled
572
345
return
573
346
self.send_changedstate()
574
self.expires = datetime.datetime.utcnow() + self.timeout
575
self.enabled = True
576
347
self.last_enabled = datetime.datetime.utcnow()
577
self.init_checker()
578
579
def disable(self, quiet=True):
580
"""Disable this client."""
581
if not getattr(self, "enabled", False):
582
return False
583
if not quiet:
584
self.send_changedstate()
585
if not quiet:
586
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
588
gobject.source_remove(self.disable_initiator_tag)
589
self.disable_initiator_tag = None
590
self.expires = None
591
if getattr(self, "checker_initiator_tag", False):
592
gobject.source_remove(self.checker_initiator_tag)
593
self.checker_initiator_tag = None
594
self.stop_checker()
595
self.enabled = False
596
# Do not run this again if called by a gobject.timeout_add
597
return False
598
599
def __del__(self):
600
self.disable()
601
602
def init_checker(self):
603
348
# Schedule a new checker to be started an 'interval' from now,
604
349
# and every interval from then on.
605
350
self.checker_initiator_tag = (gobject.timeout_add
609
354
self.disable_initiator_tag = (gobject.timeout_add
610
355
(self.timeout_milliseconds(),
611
356
self.disable))
357
self.enabled = True
612
358
# Also start a new checker *right now*.
613
359
self.start_checker()
614
360
361
def disable(self, quiet=True):
362
"""Disable this client."""
363
if not getattr(self, "enabled", False):
364
return False
365
if not quiet:
366
self.send_changedstate()
367
if not quiet:
368
logger.info(u"Disabling client %s", self.name)
369
if getattr(self, u"disable_initiator_tag", False):
370
gobject.source_remove(self.disable_initiator_tag)
371
self.disable_initiator_tag = None
372
if getattr(self, u"checker_initiator_tag", False):
373
gobject.source_remove(self.checker_initiator_tag)
374
self.checker_initiator_tag = None
375
self.stop_checker()
376
if self.disable_hook:
377
self.disable_hook(self)
378
self.enabled = False
379
# Do not run this again if called by a gobject.timeout_add
380
return False
381
382
def __del__(self):
383
self.disable_hook = None
384
self.disable()
385
615
386
def checker_callback(self, pid, condition, command):
616
387
"""The checker has completed, so take appropriate actions."""
617
388
self.checker_callback_tag = None
618
389
self.checker = None
619
390
if os.WIFEXITED(condition):
620
self.last_checker_status = os.WEXITSTATUS(condition)
621
if self.last_checker_status == 0:
622
logger.info("Checker for %(name)s succeeded",
391
exitstatus = os.WEXITSTATUS(condition)
392
if exitstatus == 0:
393
logger.info(u"Checker for %(name)s succeeded",
623
394
vars(self))
624
395
self.checked_ok()
625
396
else:
626
logger.info("Checker for %(name)s failed",
397
logger.info(u"Checker for %(name)s failed",
627
398
vars(self))
628
399
else:
629
self.last_checker_status = -1
630
logger.warning("Checker for %(name)s crashed?",
400
logger.warning(u"Checker for %(name)s crashed?",
631
401
vars(self))
632
402
633
403
def checked_ok(self):
634
"""Assert that the client has been seen, alive and well."""
404
"""Bump up the timeout for this client.
405
406
This should only be called when the client has been seen,
407
alive and well.
408
"""
635
409
self.last_checked_ok = datetime.datetime.utcnow()
636
self.last_checker_status = 0
637
self.bump_timeout()
638
639
def bump_timeout(self, timeout=None):
640
"""Bump up the timeout for this client."""
641
if timeout is None:
642
timeout = self.timeout
643
if self.disable_initiator_tag is not None:
644
gobject.source_remove(self.disable_initiator_tag)
645
if getattr(self, "enabled", False):
646
self.disable_initiator_tag = (gobject.timeout_add
647
(timedelta_to_milliseconds
648
(timeout), self.disable))
649
self.expires = datetime.datetime.utcnow() + timeout
650
651
def need_approval(self):
652
self.last_approval_request = datetime.datetime.utcnow()
410
gobject.source_remove(self.disable_initiator_tag)
411
self.disable_initiator_tag = (gobject.timeout_add
412
(self.timeout_milliseconds(),
413
self.disable))
653
414
654
415
def start_checker(self):
655
416
"""Start a new checker subprocess if one is not running.
657
418
If a checker already exists, leave it running and do
658
419
nothing."""
659
420
# The reason for not killing a running checker is that if we
660
# did that, and if a checker (for some reason) started running
661
# slowly and taking more than 'interval' time, then the client
662
# would inevitably timeout, since no checker would get a
663
# chance to run to completion. If we instead leave running
421
# did that, then if a checker (for some reason) started
422
# running slowly and taking more than 'interval' time, the
423
# client would inevitably timeout, since no checker would get
424
# a chance to run to completion. If we instead leave running
664
425
# checkers alone, the checker would have to take more time
665
426
# than 'timeout' for the client to be disabled, which is as it
666
427
# should be.
668
429
# If a checker exists, make sure it is not a zombie
669
430
try:
670
431
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
except (AttributeError, OSError) as error:
432
except (AttributeError, OSError), error:
672
433
if (isinstance(error, OSError)
673
434
and error.errno != errno.ECHILD):
674
435
raise error
675
436
else:
676
437
if pid:
677
logger.warning("Checker was a zombie")
438
logger.warning(u"Checker was a zombie")
678
439
gobject.source_remove(self.checker_callback_tag)
679
440
self.checker_callback(pid, status,
680
441
self.current_checker_command)
685
446
command = self.checker_command % self.host
686
447
except TypeError:
687
448
# Escape attributes for the shell
688
escaped_attrs = dict(
689
(attr,
690
re.escape(unicode(str(getattr(self, attr, "")),
691
errors=
692
'replace')))
693
for attr in
694
self.runtime_expansions)
695
449
escaped_attrs = dict((key,
450
re.escape(unicode(str(val),
451
errors=
452
u'replace')))
453
for key, val in
454
vars(self).iteritems())
696
455
try:
697
456
command = self.checker_command % escaped_attrs
698
except TypeError as error:
699
logger.error('Could not format string "%s"',
700
self.checker_command, exc_info=error)
457
except TypeError, error:
458
logger.error(u'Could not format string "%s":'
459
u' %s', self.checker_command, error)
701
460
return True # Try again later
702
461
self.current_checker_command = command
703
462
try:
704
logger.info("Starting checker %r for %s",
463
logger.info(u"Starting checker %r for %s",
705
464
command, self.name)
706
465
# We don't need to redirect stdout and stderr, since
707
466
# in normal mode, that is already done by daemon(),
709
468
# always replaced by /dev/null.)
710
469
self.checker = subprocess.Popen(command,
711
470
close_fds=True,
712
shell=True, cwd="/")
471
shell=True, cwd=u"/")
713
472
self.checker_callback_tag = (gobject.child_watch_add
714
473
(self.checker.pid,
715
474
self.checker_callback,
720
479
if pid:
721
480
gobject.source_remove(self.checker_callback_tag)
722
481
self.checker_callback(pid, status, command)
723
except OSError as error:
724
logger.error("Failed to start subprocess",
725
exc_info=error)
482
except OSError, error:
483
logger.error(u"Failed to start subprocess: %s",
484
error)
726
485
# Re-run this periodically if run by gobject.timeout_add
727
486
return True
728
487
731
490
if self.checker_callback_tag:
732
491
gobject.source_remove(self.checker_callback_tag)
733
492
self.checker_callback_tag = None
734
if getattr(self, "checker", None) is None:
493
if getattr(self, u"checker", None) is None:
735
494
return
736
logger.debug("Stopping checker for %(name)s", vars(self))
495
logger.debug(u"Stopping checker for %(name)s", vars(self))
737
496
try:
738
self.checker.terminate()
497
os.kill(self.checker.pid, signal.SIGTERM)
739
498
#time.sleep(0.5)
740
499
#if self.checker.poll() is None:
741
# self.checker.kill()
742
except OSError as error:
500
# os.kill(self.checker.pid, signal.SIGKILL)
501
except OSError, error:
743
502
if error.errno != errno.ESRCH: # No such process
744
503
raise
745
504
self.checker = None
746
505
747
748
def dbus_service_property(dbus_interface, signature="v",
749
access="readwrite", byte_arrays=False):
506
def dbus_service_property(dbus_interface, signature=u"v",
507
access=u"readwrite", byte_arrays=False):
750
508
"""Decorators for marking methods of a DBusObjectWithProperties to
751
509
become properties on the D-Bus.
752
510
759
517
"""
760
518
# Encoding deeply encoded byte arrays is not supported yet by the
761
519
# "Set" method, so we fail early here:
762
if byte_arrays and signature != "ay":
763
raise ValueError("Byte arrays not supported for non-'ay'"
764
" signature {0!r}".format(signature))
520
if byte_arrays and signature != u"ay":
521
raise ValueError(u"Byte arrays not supported for non-'ay'"
522
u" signature %r" % signature)
765
523
def decorator(func):
766
524
func._dbus_is_property = True
767
525
func._dbus_interface = dbus_interface
768
526
func._dbus_signature = signature
769
527
func._dbus_access = access
770
528
func._dbus_name = func.__name__
771
if func._dbus_name.endswith("_dbus_property"):
529
if func._dbus_name.endswith(u"_dbus_property"):
772
530
func._dbus_name = func._dbus_name[:-14]
773
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
774
return func
775
return decorator
776
777
778
def dbus_interface_annotations(dbus_interface):
779
"""Decorator for marking functions returning interface annotations
780
781
Usage:
782
783
@dbus_interface_annotations("org.example.Interface")
784
def _foo(self): # Function name does not matter
785
return {"org.freedesktop.DBus.Deprecated": "true",
786
"org.freedesktop.DBus.Property.EmitsChangedSignal":
787
"false"}
788
"""
789
def decorator(func):
790
func._dbus_is_interface = True
791
func._dbus_interface = dbus_interface
792
func._dbus_name = dbus_interface
793
return func
794
return decorator
795
796
797
def dbus_annotations(annotations):
798
"""Decorator to annotate D-Bus methods, signals or properties
799
Usage:
800
801
@dbus_service_property("org.example.Interface", signature="b",
802
access="r")
803
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
804
"org.freedesktop.DBus.Property."
805
"EmitsChangedSignal": "false"})
806
def Property_dbus_property(self):
807
return dbus.Boolean(False)
808
"""
809
def decorator(func):
810
func._dbus_annotations = annotations
531
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
811
532
return func
812
533
return decorator
813
534
833
554
834
555
class DBusObjectWithProperties(dbus.service.Object):
835
556
"""A D-Bus object with properties.
836
557
837
558
Classes inheriting from this can use the dbus_service_property
838
559
decorator to expose methods as D-Bus properties. It exposes the
839
560
standard Get(), Set(), and GetAll() methods on the D-Bus.
840
561
"""
841
562
842
563
@staticmethod
843
def _is_dbus_thing(thing):
844
"""Returns a function testing if an attribute is a D-Bus thing
845
846
If called like _is_dbus_thing("method") it returns a function
847
suitable for use as predicate to inspect.getmembers().
848
"""
849
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
850
False)
564
def _is_dbus_property(obj):
565
return getattr(obj, u"_dbus_is_property", False)
851
566
852
def _get_all_dbus_things(self, thing):
567
def _get_all_dbus_properties(self):
853
568
"""Returns a generator of (name, attribute) pairs
854
569
"""
855
return ((getattr(athing.__get__(self), "_dbus_name",
856
name),
857
athing.__get__(self))
858
for cls in self.__class__.__mro__
859
for name, athing in
860
inspect.getmembers(cls,
861
self._is_dbus_thing(thing)))
570
return ((prop._dbus_name, prop)
571
for name, prop in
572
inspect.getmembers(self, self._is_dbus_property))
862
573
863
574
def _get_dbus_property(self, interface_name, property_name):
864
575
"""Returns a bound method if one exists which is a D-Bus
865
576
property with the specified name and interface.
866
577
"""
867
for cls in self.__class__.__mro__:
868
for name, value in (inspect.getmembers
869
(cls,
870
self._is_dbus_thing("property"))):
871
if (value._dbus_name == property_name
872
and value._dbus_interface == interface_name):
873
return value.__get__(self)
874
578
for name in (property_name,
579
property_name + u"_dbus_property"):
580
prop = getattr(self, name, None)
581
if (prop is None
582
or not self._is_dbus_property(prop)
583
or prop._dbus_name != property_name
584
or (interface_name and prop._dbus_interface
585
and interface_name != prop._dbus_interface)):
586
continue
587
return prop
875
588
# No such property
876
raise DBusPropertyNotFound(self.dbus_object_path + ":"
877
+ interface_name + "."
589
raise DBusPropertyNotFound(self.dbus_object_path + u":"
590
+ interface_name + u"."
878
591
+ property_name)
879
592
880
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
881
out_signature="v")
593
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
594
out_signature=u"v")
882
595
def Get(self, interface_name, property_name):
883
596
"""Standard D-Bus property Get() method, see D-Bus standard.
884
597
"""
885
598
prop = self._get_dbus_property(interface_name, property_name)
886
if prop._dbus_access == "write":
599
if prop._dbus_access == u"write":
887
600
raise DBusPropertyAccessException(property_name)
888
601
value = prop()
889
if not hasattr(value, "variant_level"):
602
if not hasattr(value, u"variant_level"):
890
603
return value
891
604
return type(value)(value, variant_level=value.variant_level+1)
892
605
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
606
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
894
607
def Set(self, interface_name, property_name, value):
895
608
"""Standard D-Bus property Set() method, see D-Bus standard.
896
609
"""
897
610
prop = self._get_dbus_property(interface_name, property_name)
898
if prop._dbus_access == "read":
611
if prop._dbus_access == u"read":
899
612
raise DBusPropertyAccessException(property_name)
900
if prop._dbus_get_args_options["byte_arrays"]:
613
if prop._dbus_get_args_options[u"byte_arrays"]:
901
614
# The byte_arrays option is not supported yet on
902
615
# signatures other than "ay".
903
if prop._dbus_signature != "ay":
616
if prop._dbus_signature != u"ay":
904
617
raise ValueError
905
value = dbus.ByteArray(b''.join(chr(byte)
906
for byte in value))
618
value = dbus.ByteArray(''.join(unichr(byte)
619
for byte in value))
907
620
prop(value)
908
621
909
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
910
out_signature="a{sv}")
622
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
623
out_signature=u"a{sv}")
911
624
def GetAll(self, interface_name):
912
625
"""Standard D-Bus property GetAll() method, see D-Bus
913
626
standard.
914
627
915
628
Note: Will not include properties with access="write".
916
629
"""
917
properties = {}
918
for name, prop in self._get_all_dbus_things("property"):
630
all = {}
631
for name, prop in self._get_all_dbus_properties():
919
632
if (interface_name
920
633
and interface_name != prop._dbus_interface):
921
634
# Interface non-empty but did not match
922
635
continue
923
636
# Ignore write-only properties
924
if prop._dbus_access == "write":
637
if prop._dbus_access == u"write":
925
638
continue
926
639
value = prop()
927
if not hasattr(value, "variant_level"):
928
properties[name] = value
640
if not hasattr(value, u"variant_level"):
641
all[name] = value
929
642
continue
930
properties[name] = type(value)(value, variant_level=
931
value.variant_level+1)
932
return dbus.Dictionary(properties, signature="sv")
643
all[name] = type(value)(value, variant_level=
644
value.variant_level+1)
645
return dbus.Dictionary(all, signature=u"sv")
933
646
934
647
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
935
out_signature="s",
648
out_signature=u"s",
936
649
path_keyword='object_path',
937
650
connection_keyword='connection')
938
651
def Introspect(self, object_path, connection):
939
"""Overloading of standard D-Bus method.
940
941
Inserts property tags and interface annotation tags.
652
"""Standard D-Bus method, overloaded to insert property tags.
942
653
"""
943
654
xmlstring = dbus.service.Object.Introspect(self, object_path,
944
655
connection)
945
656
try:
946
657
document = xml.dom.minidom.parseString(xmlstring)
947
658
def make_tag(document, name, prop):
948
e = document.createElement("property")
949
e.setAttribute("name", name)
950
e.setAttribute("type", prop._dbus_signature)
951
e.setAttribute("access", prop._dbus_access)
659
e = document.createElement(u"property")
660
e.setAttribute(u"name", name)
661
e.setAttribute(u"type", prop._dbus_signature)
662
e.setAttribute(u"access", prop._dbus_access)
952
663
return e
953
for if_tag in document.getElementsByTagName("interface"):
954
# Add property tags
664
for if_tag in document.getElementsByTagName(u"interface"):
955
665
for tag in (make_tag(document, name, prop)
956
666
for name, prop
957
in self._get_all_dbus_things("property")
667
in self._get_all_dbus_properties()
958
668
if prop._dbus_interface
959
== if_tag.getAttribute("name")):
669
== if_tag.getAttribute(u"name")):
960
670
if_tag.appendChild(tag)
961
# Add annotation tags
962
for typ in ("method", "signal", "property"):
963
for tag in if_tag.getElementsByTagName(typ):
964
annots = dict()
965
for name, prop in (self.
966
_get_all_dbus_things(typ)):
967
if (name == tag.getAttribute("name")
968
and prop._dbus_interface
969
== if_tag.getAttribute("name")):
970
annots.update(getattr
971
(prop,
972
"_dbus_annotations",
973
{}))
974
for name, value in annots.iteritems():
975
ann_tag = document.createElement(
976
"annotation")
977
ann_tag.setAttribute("name", name)
978
ann_tag.setAttribute("value", value)
979
tag.appendChild(ann_tag)
980
# Add interface annotation tags
981
for annotation, value in dict(
982
itertools.chain.from_iterable(
983
annotations().iteritems()
984
for name, annotations in
985
self._get_all_dbus_things("interface")
986
if name == if_tag.getAttribute("name")
987
)).iteritems():
988
ann_tag = document.createElement("annotation")
989
ann_tag.setAttribute("name", annotation)
990
ann_tag.setAttribute("value", value)
991
if_tag.appendChild(ann_tag)
992
671
# Add the names to the return values for the
993
672
# "org.freedesktop.DBus.Properties" methods
994
if (if_tag.getAttribute("name")
995
== "org.freedesktop.DBus.Properties"):
996
for cn in if_tag.getElementsByTagName("method"):
997
if cn.getAttribute("name") == "Get":
998
for arg in cn.getElementsByTagName("arg"):
999
if (arg.getAttribute("direction")
1000
== "out"):
1001
arg.setAttribute("name", "value")
1002
elif cn.getAttribute("name") == "GetAll":
1003
for arg in cn.getElementsByTagName("arg"):
1004
if (arg.getAttribute("direction")
1005
== "out"):
1006
arg.setAttribute("name", "props")
1007
xmlstring = document.toxml("utf-8")
673
if (if_tag.getAttribute(u"name")
674
== u"org.freedesktop.DBus.Properties"):
675
for cn in if_tag.getElementsByTagName(u"method"):
676
if cn.getAttribute(u"name") == u"Get":
677
for arg in cn.getElementsByTagName(u"arg"):
678
if (arg.getAttribute(u"direction")
679
== u"out"):
680
arg.setAttribute(u"name", u"value")
681
elif cn.getAttribute(u"name") == u"GetAll":
682
for arg in cn.getElementsByTagName(u"arg"):
683
if (arg.getAttribute(u"direction")
684
== u"out"):
685
arg.setAttribute(u"name", u"props")
686
xmlstring = document.toxml(u"utf-8")
1008
687
document.unlink()
1009
688
except (AttributeError, xml.dom.DOMException,
1010
xml.parsers.expat.ExpatError) as error:
1011
logger.error("Failed to override Introspection method",
1012
exc_info=error)
689
xml.parsers.expat.ExpatError), error:
690
logger.error(u"Failed to override Introspection method",
691
error)
1013
692
return xmlstring
1014
693
1015
694
1016
def datetime_to_dbus (dt, variant_level=0):
1017
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1018
if dt is None:
1019
return dbus.String("", variant_level = variant_level)
1020
return dbus.String(dt.isoformat(),
1021
variant_level=variant_level)
1022
1023
1024
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1025
"""A class decorator; applied to a subclass of
1026
dbus.service.Object, it will add alternate D-Bus attributes with
1027
interface names according to the "alt_interface_names" mapping.
1028
Usage:
1029
1030
@alternate_dbus_names({"org.example.Interface":
1031
"net.example.AlternateInterface"})
1032
class SampleDBusObject(dbus.service.Object):
1033
@dbus.service.method("org.example.Interface")
1034
def SampleDBusMethod():
1035
pass
1036
1037
The above "SampleDBusMethod" on "SampleDBusObject" will be
1038
reachable via two interfaces: "org.example.Interface" and
1039
"net.example.AlternateInterface", the latter of which will have
1040
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1041
"true", unless "deprecate" is passed with a False value.
1042
1043
This works for methods and signals, and also for D-Bus properties
1044
(from DBusObjectWithProperties) and interfaces (from the
1045
dbus_interface_annotations decorator).
1046
"""
1047
def wrapper(cls):
1048
for orig_interface_name, alt_interface_name in (
1049
alt_interface_names.iteritems()):
1050
attr = {}
1051
interface_names = set()
1052
# Go though all attributes of the class
1053
for attrname, attribute in inspect.getmembers(cls):
1054
# Ignore non-D-Bus attributes, and D-Bus attributes
1055
# with the wrong interface name
1056
if (not hasattr(attribute, "_dbus_interface")
1057
or not attribute._dbus_interface
1058
.startswith(orig_interface_name)):
1059
continue
1060
# Create an alternate D-Bus interface name based on
1061
# the current name
1062
alt_interface = (attribute._dbus_interface
1063
.replace(orig_interface_name,
1064
alt_interface_name))
1065
interface_names.add(alt_interface)
1066
# Is this a D-Bus signal?
1067
if getattr(attribute, "_dbus_is_signal", False):
1068
# Extract the original non-method function by
1069
# black magic
1070
nonmethod_func = (dict(
1071
zip(attribute.func_code.co_freevars,
1072
attribute.__closure__))["func"]
1073
.cell_contents)
1074
# Create a new, but exactly alike, function
1075
# object, and decorate it to be a new D-Bus signal
1076
# with the alternate D-Bus interface name
1077
new_function = (dbus.service.signal
1078
(alt_interface,
1079
attribute._dbus_signature)
1080
(types.FunctionType(
1081
nonmethod_func.func_code,
1082
nonmethod_func.func_globals,
1083
nonmethod_func.func_name,
1084
nonmethod_func.func_defaults,
1085
nonmethod_func.func_closure)))
1086
# Copy annotations, if any
1087
try:
1088
new_function._dbus_annotations = (
1089
dict(attribute._dbus_annotations))
1090
except AttributeError:
1091
pass
1092
# Define a creator of a function to call both the
1093
# original and alternate functions, so both the
1094
# original and alternate signals gets sent when
1095
# the function is called
1096
def fixscope(func1, func2):
1097
"""This function is a scope container to pass
1098
func1 and func2 to the "call_both" function
1099
outside of its arguments"""
1100
def call_both(*args, **kwargs):
1101
"""This function will emit two D-Bus
1102
signals by calling func1 and func2"""
1103
func1(*args, **kwargs)
1104
func2(*args, **kwargs)
1105
return call_both
1106
# Create the "call_both" function and add it to
1107
# the class
1108
attr[attrname] = fixscope(attribute, new_function)
1109
# Is this a D-Bus method?
1110
elif getattr(attribute, "_dbus_is_method", False):
1111
# Create a new, but exactly alike, function
1112
# object. Decorate it to be a new D-Bus method
1113
# with the alternate D-Bus interface name. Add it
1114
# to the class.
1115
attr[attrname] = (dbus.service.method
1116
(alt_interface,
1117
attribute._dbus_in_signature,
1118
attribute._dbus_out_signature)
1119
(types.FunctionType
1120
(attribute.func_code,
1121
attribute.func_globals,
1122
attribute.func_name,
1123
attribute.func_defaults,
1124
attribute.func_closure)))
1125
# Copy annotations, if any
1126
try:
1127
attr[attrname]._dbus_annotations = (
1128
dict(attribute._dbus_annotations))
1129
except AttributeError:
1130
pass
1131
# Is this a D-Bus property?
1132
elif getattr(attribute, "_dbus_is_property", False):
1133
# Create a new, but exactly alike, function
1134
# object, and decorate it to be a new D-Bus
1135
# property with the alternate D-Bus interface
1136
# name. Add it to the class.
1137
attr[attrname] = (dbus_service_property
1138
(alt_interface,
1139
attribute._dbus_signature,
1140
attribute._dbus_access,
1141
attribute
1142
._dbus_get_args_options
1143
["byte_arrays"])
1144
(types.FunctionType
1145
(attribute.func_code,
1146
attribute.func_globals,
1147
attribute.func_name,
1148
attribute.func_defaults,
1149
attribute.func_closure)))
1150
# Copy annotations, if any
1151
try:
1152
attr[attrname]._dbus_annotations = (
1153
dict(attribute._dbus_annotations))
1154
except AttributeError:
1155
pass
1156
# Is this a D-Bus interface?
1157
elif getattr(attribute, "_dbus_is_interface", False):
1158
# Create a new, but exactly alike, function
1159
# object. Decorate it to be a new D-Bus interface
1160
# with the alternate D-Bus interface name. Add it
1161
# to the class.
1162
attr[attrname] = (dbus_interface_annotations
1163
(alt_interface)
1164
(types.FunctionType
1165
(attribute.func_code,
1166
attribute.func_globals,
1167
attribute.func_name,
1168
attribute.func_defaults,
1169
attribute.func_closure)))
1170
if deprecate:
1171
# Deprecate all alternate interfaces
1172
iname="_AlternateDBusNames_interface_annotation{0}"
1173
for interface_name in interface_names:
1174
@dbus_interface_annotations(interface_name)
1175
def func(self):
1176
return { "org.freedesktop.DBus.Deprecated":
1177
"true" }
1178
# Find an unused name
1179
for aname in (iname.format(i)
1180
for i in itertools.count()):
1181
if aname not in attr:
1182
attr[aname] = func
1183
break
1184
if interface_names:
1185
# Replace the class with a new subclass of it with
1186
# methods, signals, etc. as created above.
1187
cls = type(b"{0}Alternate".format(cls.__name__),
1188
(cls,), attr)
1189
return cls
1190
return wrapper
1191
1192
1193
@alternate_dbus_interfaces({"se.recompile.Mandos":
1194
"se.bsnet.fukt.Mandos"})
1195
695
class ClientDBus(Client, DBusObjectWithProperties):
1196
696
"""A Client class using D-Bus
1197
697
1199
699
dbus_object_path: dbus.ObjectPath
1200
700
bus: dbus.SystemBus()
1201
701
"""
1202
1203
runtime_expansions = (Client.runtime_expansions
1204
+ ("dbus_object_path",))
1205
1206
702
# dbus.service.Object doesn't use super(), so we can't either.
1207
703
1208
704
def __init__(self, bus = None, *args, **kwargs):
1210
706
Client.__init__(self, *args, **kwargs)
1211
707
# Only now, when this client is initialized, can it show up on
1212
708
# the D-Bus
1213
client_object_name = unicode(self.name).translate(
1214
{ord("."): ord("_"),
1215
ord("-"): ord("_")})
1216
709
self.dbus_object_path = (dbus.ObjectPath
1217
("/clients/" + client_object_name))
710
(u"/clients/"
711
+ self.name.replace(u".", u"_")))
1218
712
DBusObjectWithProperties.__init__(self, self.bus,
1219
713
self.dbus_object_path)
1220
714
1221
def notifychangeproperty(transform_func,
1222
dbus_name, type_func=lambda x: x,
1223
variant_level=1):
1224
""" Modify a variable so that it's a property which announces
1225
its changes to DBus.
1226
1227
transform_fun: Function that takes a value and a variant_level
1228
and transforms it to a D-Bus type.
1229
dbus_name: D-Bus name of the variable
1230
type_func: Function that transform the value before sending it
1231
to the D-Bus. Default: no transform
1232
variant_level: D-Bus variant level. Default: 1
1233
"""
1234
attrname = "_{0}".format(dbus_name)
1235
def setter(self, value):
1236
if hasattr(self, "dbus_object_path"):
1237
if (not hasattr(self, attrname) or
1238
type_func(getattr(self, attrname, None))
1239
!= type_func(value)):
1240
dbus_value = transform_func(type_func(value),
1241
variant_level
1242
=variant_level)
1243
self.PropertyChanged(dbus.String(dbus_name),
1244
dbus_value)
1245
setattr(self, attrname, value)
1246
1247
return property(lambda self: getattr(self, attrname), setter)
1248
1249
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1250
approvals_pending = notifychangeproperty(dbus.Boolean,
1251
"ApprovalPending",
1252
type_func = bool)
1253
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1254
last_enabled = notifychangeproperty(datetime_to_dbus,
1255
"LastEnabled")
1256
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1257
type_func = lambda checker:
1258
checker is not None)
1259
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1260
"LastCheckedOK")
1261
last_checker_status = notifychangeproperty(dbus.Int16,
1262
"LastCheckerStatus")
1263
last_approval_request = notifychangeproperty(
1264
datetime_to_dbus, "LastApprovalRequest")
1265
approved_by_default = notifychangeproperty(dbus.Boolean,
1266
"ApprovedByDefault")
1267
approval_delay = notifychangeproperty(dbus.UInt64,
1268
"ApprovalDelay",
1269
type_func =
1270
timedelta_to_milliseconds)
1271
approval_duration = notifychangeproperty(
1272
dbus.UInt64, "ApprovalDuration",
1273
type_func = timedelta_to_milliseconds)
1274
host = notifychangeproperty(dbus.String, "Host")
1275
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1276
type_func =
1277
timedelta_to_milliseconds)
1278
extended_timeout = notifychangeproperty(
1279
dbus.UInt64, "ExtendedTimeout",
1280
type_func = timedelta_to_milliseconds)
1281
interval = notifychangeproperty(dbus.UInt64,
1282
"Interval",
1283
type_func =
1284
timedelta_to_milliseconds)
1285
checker_command = notifychangeproperty(dbus.String, "Checker")
1286
1287
del notifychangeproperty
715
@staticmethod
716
def _datetime_to_dbus(dt, variant_level=0):
717
"""Convert a UTC datetime.datetime() to a D-Bus type."""
718
return dbus.String(dt.isoformat(),
719
variant_level=variant_level)
720
721
def enable(self):
722
oldstate = getattr(self, u"enabled", False)
723
r = Client.enable(self)
724
if oldstate != self.enabled:
725
# Emit D-Bus signals
726
self.PropertyChanged(dbus.String(u"enabled"),
727
dbus.Boolean(True, variant_level=1))
728
self.PropertyChanged(
729
dbus.String(u"last_enabled"),
730
self._datetime_to_dbus(self.last_enabled,
731
variant_level=1))
732
return r
733
734
def disable(self, quiet = False):
735
oldstate = getattr(self, u"enabled", False)
736
r = Client.disable(self, quiet=quiet)
737
if not quiet and oldstate != self.enabled:
738
# Emit D-Bus signal
739
self.PropertyChanged(dbus.String(u"enabled"),
740
dbus.Boolean(False, variant_level=1))
741
return r
1288
742
1289
743
def __del__(self, *args, **kwargs):
1290
744
try:
1291
745
self.remove_from_connection()
1292
746
except LookupError:
1293
747
pass
1294
if hasattr(DBusObjectWithProperties, "__del__"):
748
if hasattr(DBusObjectWithProperties, u"__del__"):
1295
749
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1296
750
Client.__del__(self, *args, **kwargs)
1297
751
1299
753
*args, **kwargs):
1300
754
self.checker_callback_tag = None
1301
755
self.checker = None
756
# Emit D-Bus signal
757
self.PropertyChanged(dbus.String(u"checker_running"),
758
dbus.Boolean(False, variant_level=1))
1302
759
if os.WIFEXITED(condition):
1303
760
exitstatus = os.WEXITSTATUS(condition)
1304
761
# Emit D-Bus signal
1314
771
return Client.checker_callback(self, pid, condition, command,
1315
772
*args, **kwargs)
1316
773
774
def checked_ok(self, *args, **kwargs):
775
r = Client.checked_ok(self, *args, **kwargs)
776
# Emit D-Bus signal
777
self.PropertyChanged(
778
dbus.String(u"last_checked_ok"),
779
(self._datetime_to_dbus(self.last_checked_ok,
780
variant_level=1)))
781
return r
782
1317
783
def start_checker(self, *args, **kwargs):
1318
784
old_checker = self.checker
1319
785
if self.checker is not None:
1326
792
and old_checker_pid != self.checker.pid):
1327
793
# Emit D-Bus signal
1328
794
self.CheckerStarted(self.current_checker_command)
795
self.PropertyChanged(
796
dbus.String(u"checker_running"),
797
dbus.Boolean(True, variant_level=1))
1329
798
return r
1330
799
800
def stop_checker(self, *args, **kwargs):
801
old_checker = getattr(self, u"checker", None)
802
r = Client.stop_checker(self, *args, **kwargs)
803
if (old_checker is not None
804
and getattr(self, u"checker", None) is None):
805
self.PropertyChanged(dbus.String(u"checker_running"),
806
dbus.Boolean(False, variant_level=1))
807
return r
808
1331
809
def _reset_approved(self):
1332
self.approved = None
810
self._approved = None
1333
811
return False
1334
812
1335
813
def approve(self, value=True):
1336
self.send_changedstate()
1337
self.approved = value
1338
gobject.timeout_add(timedelta_to_milliseconds
1339
(self.approval_duration),
1340
self._reset_approved)
814
self._approved = value
815
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
816
817
def approved_pending(self):
818
return self.approvals_pending > 0
819
1341
820
1342
821
## D-Bus methods, signals & properties
1343
_interface = "se.recompile.Mandos.Client"
1344
1345
## Interfaces
1346
1347
@dbus_interface_annotations(_interface)
1348
def _foo(self):
1349
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1350
"false"}
822
_interface = u"se.bsnet.fukt.Mandos.Client"
1351
823
1352
824
## Signals
1353
825
1354
826
# CheckerCompleted - signal
1355
@dbus.service.signal(_interface, signature="nxs")
827
@dbus.service.signal(_interface, signature=u"nxs")
1356
828
def CheckerCompleted(self, exitcode, waitstatus, command):
1357
829
"D-Bus signal"
1358
830
pass
1359
831
1360
832
# CheckerStarted - signal
1361
@dbus.service.signal(_interface, signature="s")
833
@dbus.service.signal(_interface, signature=u"s")
1362
834
def CheckerStarted(self, command):
1363
835
"D-Bus signal"
1364
836
pass
1365
837
1366
838
# PropertyChanged - signal
1367
@dbus.service.signal(_interface, signature="sv")
839
@dbus.service.signal(_interface, signature=u"sv")
1368
840
def PropertyChanged(self, property, value):
1369
841
"D-Bus signal"
1370
842
pass
1372
844
# GotSecret - signal
1373
845
@dbus.service.signal(_interface)
1374
846
def GotSecret(self):
1375
"""D-Bus signal
1376
Is sent after a successful transfer of secret from the Mandos
1377
server to mandos-client
1378
"""
1379
pass
847
"D-Bus signal"
848
if self.approved_pending():
849
self.PropertyChanged(dbus.String(u"checker_running"),
850
dbus.Boolean(False, variant_level=1))
1380
851
1381
852
# Rejected - signal
1382
@dbus.service.signal(_interface, signature="s")
853
@dbus.service.signal(_interface, signature=u"s")
1383
854
def Rejected(self, reason):
1384
855
"D-Bus signal"
1385
pass
856
if self.approved_pending():
857
self.PropertyChanged(dbus.String(u"checker_running"),
858
dbus.Boolean(False, variant_level=1))
1386
859
1387
860
# NeedApproval - signal
1388
@dbus.service.signal(_interface, signature="tb")
861
@dbus.service.signal(_interface, signature=u"db")
1389
862
def NeedApproval(self, timeout, default):
1390
863
"D-Bus signal"
1391
return self.need_approval()
864
if not self.approved_pending():
865
self.PropertyChanged(dbus.String(u"approved_pending"),
866
dbus.Boolean(True, variant_level=1))
1392
867
1393
868
## Methods
1394
869
1395
870
# Approve - method
1396
@dbus.service.method(_interface, in_signature="b")
871
@dbus.service.method(_interface, in_signature=u"b")
1397
872
def Approve(self, value):
1398
873
self.approve(value)
1399
874
1400
875
# CheckedOK - method
1401
876
@dbus.service.method(_interface)
1402
877
def CheckedOK(self):
1403
self.checked_ok()
878
return self.checked_ok()
1404
879
1405
880
# Enable - method
1406
881
@dbus.service.method(_interface)
1427
902
1428
903
## Properties
1429
904
1430
# ApprovalPending - property
1431
@dbus_service_property(_interface, signature="b", access="read")
1432
def ApprovalPending_dbus_property(self):
1433
return dbus.Boolean(bool(self.approvals_pending))
1434
1435
# ApprovedByDefault - property
1436
@dbus_service_property(_interface, signature="b",
1437
access="readwrite")
1438
def ApprovedByDefault_dbus_property(self, value=None):
1439
if value is None: # get
1440
return dbus.Boolean(self.approved_by_default)
1441
self.approved_by_default = bool(value)
1442
1443
# ApprovalDelay - property
1444
@dbus_service_property(_interface, signature="t",
1445
access="readwrite")
1446
def ApprovalDelay_dbus_property(self, value=None):
1447
if value is None: # get
1448
return dbus.UInt64(self.approval_delay_milliseconds())
1449
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1450
1451
# ApprovalDuration - property
1452
@dbus_service_property(_interface, signature="t",
1453
access="readwrite")
1454
def ApprovalDuration_dbus_property(self, value=None):
1455
if value is None: # get
1456
return dbus.UInt64(timedelta_to_milliseconds(
1457
self.approval_duration))
1458
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1459
1460
# Name - property
1461
@dbus_service_property(_interface, signature="s", access="read")
1462
def Name_dbus_property(self):
905
# approved_pending - property
906
@dbus_service_property(_interface, signature=u"b", access=u"read")
907
def approved_pending_dbus_property(self):
908
return dbus.Boolean(self.approved_pending())
909
910
# approved_by_default - property
911
@dbus_service_property(_interface, signature=u"b",
912
access=u"readwrite")
913
def approved_by_default_dbus_property(self):
914
return dbus.Boolean(self.approved_by_default)
915
916
# approved_delay - property
917
@dbus_service_property(_interface, signature=u"t",
918
access=u"readwrite")
919
def approved_delay_dbus_property(self):
920
return dbus.UInt64(self.approved_delay_milliseconds())
921
922
# approved_duration - property
923
@dbus_service_property(_interface, signature=u"t",
924
access=u"readwrite")
925
def approved_duration_dbus_property(self):
926
return dbus.UInt64(self._timedelta_to_milliseconds(
927
self.approved_duration))
928
929
# name - property
930
@dbus_service_property(_interface, signature=u"s", access=u"read")
931
def name_dbus_property(self):
1463
932
return dbus.String(self.name)
1464
933
1465
# Fingerprint - property
1466
@dbus_service_property(_interface, signature="s", access="read")
1467
def Fingerprint_dbus_property(self):
934
# fingerprint - property
935
@dbus_service_property(_interface, signature=u"s", access=u"read")
936
def fingerprint_dbus_property(self):
1468
937
return dbus.String(self.fingerprint)
1469
938
1470
# Host - property
1471
@dbus_service_property(_interface, signature="s",
1472
access="readwrite")
1473
def Host_dbus_property(self, value=None):
939
# host - property
940
@dbus_service_property(_interface, signature=u"s",
941
access=u"readwrite")
942
def host_dbus_property(self, value=None):
1474
943
if value is None: # get
1475
944
return dbus.String(self.host)
1476
self.host = unicode(value)
1477
1478
# Created - property
1479
@dbus_service_property(_interface, signature="s", access="read")
1480
def Created_dbus_property(self):
1481
return datetime_to_dbus(self.created)
1482
1483
# LastEnabled - property
1484
@dbus_service_property(_interface, signature="s", access="read")
1485
def LastEnabled_dbus_property(self):
1486
return datetime_to_dbus(self.last_enabled)
1487
1488
# Enabled - property
1489
@dbus_service_property(_interface, signature="b",
1490
access="readwrite")
1491
def Enabled_dbus_property(self, value=None):
945
self.host = value
946
# Emit D-Bus signal
947
self.PropertyChanged(dbus.String(u"host"),
948
dbus.String(value, variant_level=1))
949
950
# created - property
951
@dbus_service_property(_interface, signature=u"s", access=u"read")
952
def created_dbus_property(self):
953
return dbus.String(self._datetime_to_dbus(self.created))
954
955
# last_enabled - property
956
@dbus_service_property(_interface, signature=u"s", access=u"read")
957
def last_enabled_dbus_property(self):
958
if self.last_enabled is None:
959
return dbus.String(u"")
960
return dbus.String(self._datetime_to_dbus(self.last_enabled))
961
962
# enabled - property
963
@dbus_service_property(_interface, signature=u"b",
964
access=u"readwrite")
965
def enabled_dbus_property(self, value=None):
1492
966
if value is None: # get
1493
967
return dbus.Boolean(self.enabled)
1494
968
if value:
1496
970
else:
1497
971
self.disable()
1498
972
1499
# LastCheckedOK - property
1500
@dbus_service_property(_interface, signature="s",
1501
access="readwrite")
1502
def LastCheckedOK_dbus_property(self, value=None):
973
# last_checked_ok - property
974
@dbus_service_property(_interface, signature=u"s",
975
access=u"readwrite")
976
def last_checked_ok_dbus_property(self, value=None):
1503
977
if value is not None:
1504
978
self.checked_ok()
1505
979
return
1506
return datetime_to_dbus(self.last_checked_ok)
1507
1508
# LastCheckerStatus - property
1509
@dbus_service_property(_interface, signature="n",
1510
access="read")
1511
def LastCheckerStatus_dbus_property(self):
1512
return dbus.Int16(self.last_checker_status)
1513
1514
# Expires - property
1515
@dbus_service_property(_interface, signature="s", access="read")
1516
def Expires_dbus_property(self):
1517
return datetime_to_dbus(self.expires)
1518
1519
# LastApprovalRequest - property
1520
@dbus_service_property(_interface, signature="s", access="read")
1521
def LastApprovalRequest_dbus_property(self):
1522
return datetime_to_dbus(self.last_approval_request)
1523
1524
# Timeout - property
1525
@dbus_service_property(_interface, signature="t",
1526
access="readwrite")
1527
def Timeout_dbus_property(self, value=None):
980
if self.last_checked_ok is None:
981
return dbus.String(u"")
982
return dbus.String(self._datetime_to_dbus(self
983
.last_checked_ok))
984
985
# timeout - property
986
@dbus_service_property(_interface, signature=u"t",
987
access=u"readwrite")
988
def timeout_dbus_property(self, value=None):
1528
989
if value is None: # get
1529
990
return dbus.UInt64(self.timeout_milliseconds())
1530
991
self.timeout = datetime.timedelta(0, 0, 0, value)
992
# Emit D-Bus signal
993
self.PropertyChanged(dbus.String(u"timeout"),
994
dbus.UInt64(value, variant_level=1))
995
if getattr(self, u"disable_initiator_tag", None) is None:
996
return
1531
997
# Reschedule timeout
1532
if self.enabled:
1533
now = datetime.datetime.utcnow()
1534
time_to_die = timedelta_to_milliseconds(
1535
(self.last_checked_ok + self.timeout) - now)
1536
if time_to_die <= 0:
1537
# The timeout has passed
1538
self.disable()
1539
else:
1540
self.expires = (now +
1541
datetime.timedelta(milliseconds =
1542
time_to_die))
1543
if (getattr(self, "disable_initiator_tag", None)
1544
is None):
1545
return
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (gobject.timeout_add
1548
(time_to_die,
1549
self.disable))
1550
1551
# ExtendedTimeout - property
1552
@dbus_service_property(_interface, signature="t",
1553
access="readwrite")
1554
def ExtendedTimeout_dbus_property(self, value=None):
1555
if value is None: # get
1556
return dbus.UInt64(self.extended_timeout_milliseconds())
1557
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1558
1559
# Interval - property
1560
@dbus_service_property(_interface, signature="t",
1561
access="readwrite")
1562
def Interval_dbus_property(self, value=None):
998
gobject.source_remove(self.disable_initiator_tag)
999
self.disable_initiator_tag = None
1000
time_to_die = (self.
1001
_timedelta_to_milliseconds((self
1002
.last_checked_ok
1003
+ self.timeout)
1004
- datetime.datetime
1005
.utcnow()))
1006
if time_to_die <= 0:
1007
# The timeout has passed
1008
self.disable()
1009
else:
1010
self.disable_initiator_tag = (gobject.timeout_add
1011
(time_to_die, self.disable))
1012
1013
# interval - property
1014
@dbus_service_property(_interface, signature=u"t",
1015
access=u"readwrite")
1016
def interval_dbus_property(self, value=None):
1563
1017
if value is None: # get
1564
1018
return dbus.UInt64(self.interval_milliseconds())
1565
1019
self.interval = datetime.timedelta(0, 0, 0, value)
1566
if getattr(self, "checker_initiator_tag", None) is None:
1020
# Emit D-Bus signal
1021
self.PropertyChanged(dbus.String(u"interval"),
1022
dbus.UInt64(value, variant_level=1))
1023
if getattr(self, u"checker_initiator_tag", None) is None:
1567
1024
return
1568
if self.enabled:
1569
# Reschedule checker run
1570
gobject.source_remove(self.checker_initiator_tag)
1571
self.checker_initiator_tag = (gobject.timeout_add
1572
(value, self.start_checker))
1573
self.start_checker() # Start one now, too
1574
1575
# Checker - property
1576
@dbus_service_property(_interface, signature="s",
1577
access="readwrite")
1578
def Checker_dbus_property(self, value=None):
1025
# Reschedule checker run
1026
gobject.source_remove(self.checker_initiator_tag)
1027
self.checker_initiator_tag = (gobject.timeout_add
1028
(value, self.start_checker))
1029
self.start_checker() # Start one now, too
1030
1031
# checker - property
1032
@dbus_service_property(_interface, signature=u"s",
1033
access=u"readwrite")
1034
def checker_dbus_property(self, value=None):
1579
1035
if value is None: # get
1580
1036
return dbus.String(self.checker_command)
1581
self.checker_command = unicode(value)
1037
self.checker_command = value
1038
# Emit D-Bus signal
1039
self.PropertyChanged(dbus.String(u"checker"),
1040
dbus.String(self.checker_command,
1041
variant_level=1))
1582
1042
1583
# CheckerRunning - property
1584
@dbus_service_property(_interface, signature="b",
1585
access="readwrite")
1586
def CheckerRunning_dbus_property(self, value=None):
1043
# checker_running - property
1044
@dbus_service_property(_interface, signature=u"b",
1045
access=u"readwrite")
1046
def checker_running_dbus_property(self, value=None):
1587
1047
if value is None: # get
1588
1048
return dbus.Boolean(self.checker is not None)
1589
1049
if value:
1591
1051
else:
1592
1052
self.stop_checker()
1593
1053
1594
# ObjectPath - property
1595
@dbus_service_property(_interface, signature="o", access="read")
1596
def ObjectPath_dbus_property(self):
1054
# object_path - property
1055
@dbus_service_property(_interface, signature=u"o", access=u"read")
1056
def object_path_dbus_property(self):
1597
1057
return self.dbus_object_path # is already a dbus.ObjectPath
1598
1058
1599
# Secret = property
1600
@dbus_service_property(_interface, signature="ay",
1601
access="write", byte_arrays=True)
1602
def Secret_dbus_property(self, value):
1059
# secret = property
1060
@dbus_service_property(_interface, signature=u"ay",
1061
access=u"write", byte_arrays=True)
1062
def secret_dbus_property(self, value):
1603
1063
self.secret = str(value)
1604
1064
1605
1065
del _interface
1611
1071
self._pipe.send(('init', fpr, address))
1612
1072
if not self._pipe.recv():
1613
1073
raise KeyError()
1614
1074
1615
1075
def __getattribute__(self, name):
1616
if name == '_pipe':
1076
if(name == '_pipe'):
1617
1077
return super(ProxyClient, self).__getattribute__(name)
1618
1078
self._pipe.send(('getattr', name))
1619
1079
data = self._pipe.recv()
1624
1084
self._pipe.send(('funcall', name, args, kwargs))
1625
1085
return self._pipe.recv()[1]
1626
1086
return func
1627
1087
1628
1088
def __setattr__(self, name, value):
1629
if name == '_pipe':
1089
if(name == '_pipe'):
1630
1090
return super(ProxyClient, self).__setattr__(name, value)
1631
1091
self._pipe.send(('setattr', name, value))
1632
1092
1639
1099
1640
1100
def handle(self):
1641
1101
with contextlib.closing(self.server.child_pipe) as child_pipe:
1642
logger.info("TCP connection from: %s",
1102
logger.info(u"TCP connection from: %s",
1643
1103
unicode(self.client_address))
1644
logger.debug("Pipe FD: %d",
1104
logger.debug(u"Pipe FD: %d",
1645
1105
self.server.child_pipe.fileno())
1646
1106
1647
1107
session = (gnutls.connection
1648
1108
.ClientSession(self.request,
1649
1109
gnutls.connection
1650
1110
.X509Credentials()))
1651
1111
1652
1112
# Note: gnutls.connection.X509Credentials is really a
1653
1113
# generic GnuTLS certificate credentials object so long as
1654
1114
# no X.509 keys are added to it. Therefore, we can use it
1655
1115
# here despite using OpenPGP certificates.
1656
1657
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1658
# "+AES-256-CBC", "+SHA1",
1659
# "+COMP-NULL", "+CTYPE-OPENPGP",
1660
# "+DHE-DSS"))
1116
1117
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1118
# u"+AES-256-CBC", u"+SHA1",
1119
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1120
# u"+DHE-DSS"))
1661
1121
# Use a fallback default, since this MUST be set.
1662
1122
priority = self.server.gnutls_priority
1663
1123
if priority is None:
1664
priority = "NORMAL"
1124
priority = u"NORMAL"
1665
1125
(gnutls.library.functions
1666
1126
.gnutls_priority_set_direct(session._c_object,
1667
1127
priority, None))
1668
1128
1669
1129
# Start communication using the Mandos protocol
1670
1130
# Get protocol number
1671
1131
line = self.request.makefile().readline()
1672
logger.debug("Protocol version: %r", line)
1132
logger.debug(u"Protocol version: %r", line)
1673
1133
try:
1674
1134
if int(line.strip().split()[0]) > 1:
1675
1135
raise RuntimeError
1676
except (ValueError, IndexError, RuntimeError) as error:
1677
logger.error("Unknown protocol version: %s", error)
1136
except (ValueError, IndexError, RuntimeError), error:
1137
logger.error(u"Unknown protocol version: %s", error)
1678
1138
return
1679
1139
1680
1140
# Start GnuTLS connection
1681
1141
try:
1682
1142
session.handshake()
1683
except gnutls.errors.GNUTLSError as error:
1684
logger.warning("Handshake failed: %s", error)
1143
except gnutls.errors.GNUTLSError, error:
1144
logger.warning(u"Handshake failed: %s", error)
1685
1145
# Do not run session.bye() here: the session is not
1686
1146
# established. Just abandon the request.
1687
1147
return
1688
logger.debug("Handshake succeeded")
1689
1148
logger.debug(u"Handshake succeeded")
1149
1690
1150
approval_required = False
1691
1151
try:
1692
1152
try:
1693
1153
fpr = self.fingerprint(self.peer_certificate
1694
1154
(session))
1695
except (TypeError,
1696
gnutls.errors.GNUTLSError) as error:
1697
logger.warning("Bad certificate: %s", error)
1155
except (TypeError, gnutls.errors.GNUTLSError), error:
1156
logger.warning(u"Bad certificate: %s", error)
1698
1157
return
1699
logger.debug("Fingerprint: %s", fpr)
1700
1158
logger.debug(u"Fingerprint: %s", fpr)
1159
1701
1160
try:
1702
1161
client = ProxyClient(child_pipe, fpr,
1703
1162
self.client_address)
1704
1163
except KeyError:
1705
1164
return
1706
1165
1707
if client.approval_delay:
1708
delay = client.approval_delay
1166
if client.approved_delay:
1167
delay = client.approved_delay
1709
1168
client.approvals_pending += 1
1710
1169
approval_required = True
1711
1170
1712
1171
while True:
1713
1172
if not client.enabled:
1714
logger.info("Client %s is disabled",
1173
logger.warning(u"Client %s is disabled",
1715
1174
client.name)
1716
1175
if self.server.use_dbus:
1717
1176
# Emit D-Bus signal
1718
client.Rejected("Disabled")
1177
client.Rejected("Disabled")
1719
1178
return
1720
1179
1721
if client.approved or not client.approval_delay:
1180
if client._approved or not client.approved_delay:
1722
1181
#We are approved or approval is disabled
1723
1182
break
1724
elif client.approved is None:
1725
logger.info("Client %s needs approval",
1183
elif client._approved is None:
1184
logger.info(u"Client %s need approval",
1726
1185
client.name)
1727
1186
if self.server.use_dbus:
1728
1187
# Emit D-Bus signal
1729
1188
client.NeedApproval(
1730
client.approval_delay_milliseconds(),
1189
client.approved_delay_milliseconds(),
1731
1190
client.approved_by_default)
1732
1191
else:
1733
logger.warning("Client %s was not approved",
1192
logger.warning(u"Client %s was not approved",
1734
1193
client.name)
1735
1194
if self.server.use_dbus:
1736
1195
# Emit D-Bus signal
1737
client.Rejected("Denied")
1196
client.Rejected("Disapproved")
1738
1197
return
1739
1198
1740
1199
#wait until timeout or approved
1200
#x = float(client._timedelta_to_milliseconds(delay))
1741
1201
time = datetime.datetime.now()
1742
1202
client.changedstate.acquire()
1743
(client.changedstate.wait
1744
(float(client.timedelta_to_milliseconds(delay)
1745
/ 1000)))
1203
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1746
1204
client.changedstate.release()
1747
1205
time2 = datetime.datetime.now()
1748
1206
if (time2 - time) >= delay:
1752
1210
client.name)
1753
1211
if self.server.use_dbus:
1754
1212
# Emit D-Bus signal
1755
client.Rejected("Approval timed out")
1213
client.Rejected("Time out")
1756
1214
return
1757
1215
else:
1758
1216
break
1761
1219
1762
1220
sent_size = 0
1763
1221
while sent_size < len(client.secret):
1764
try:
1765
sent = session.send(client.secret[sent_size:])
1766
except gnutls.errors.GNUTLSError as error:
1767
logger.warning("gnutls send failed",
1768
exc_info=error)
1769
return
1770
logger.debug("Sent: %d, remaining: %d",
1222
# XXX handle session exception
1223
sent = session.send(client.secret[sent_size:])
1224
logger.debug(u"Sent: %d, remaining: %d",
1771
1225
sent, len(client.secret)
1772
1226
- (sent_size + sent))
1773
1227
sent_size += sent
1774
1775
logger.info("Sending secret to %s", client.name)
1776
# bump the timeout using extended_timeout
1777
client.bump_timeout(client.extended_timeout)
1228
1229
logger.info(u"Sending secret to %s", client.name)
1230
# bump the timeout as if seen
1231
client.checked_ok()
1778
1232
if self.server.use_dbus:
1779
1233
# Emit D-Bus signal
1780
1234
client.GotSecret()
1782
1236
finally:
1783
1237
if approval_required:
1784
1238
client.approvals_pending -= 1
1785
try:
1786
session.bye()
1787
except gnutls.errors.GNUTLSError as error:
1788
logger.warning("GnuTLS bye failed",
1789
exc_info=error)
1239
session.bye()
1790
1240
1791
1241
@staticmethod
1792
1242
def peer_certificate(session):
1802
1252
.gnutls_certificate_get_peers
1803
1253
(session._c_object, ctypes.byref(list_size)))
1804
1254
if not bool(cert_list) and list_size.value != 0:
1805
raise gnutls.errors.GNUTLSError("error getting peer"
1806
" certificate")
1255
raise gnutls.errors.GNUTLSError(u"error getting peer"
1256
u" certificate")
1807
1257
if list_size.value == 0:
1808
1258
return None
1809
1259
cert = cert_list[0]
1835
1285
if crtverify.value != 0:
1836
1286
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1837
1287
raise (gnutls.errors.CertificateSecurityError
1838
("Verify failed"))
1288
(u"Verify failed"))
1839
1289
# New buffer for the fingerprint
1840
1290
buf = ctypes.create_string_buffer(20)
1841
1291
buf_len = ctypes.c_size_t()
1848
1298
# Convert the buffer to a Python bytestring
1849
1299
fpr = ctypes.string_at(buf, buf_len.value)
1850
1300
# Convert the bytestring to hexadecimal notation
1851
hex_fpr = binascii.hexlify(fpr).upper()
1301
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1852
1302
return hex_fpr
1853
1303
1854
1304
1857
1307
def sub_process_main(self, request, address):
1858
1308
try:
1859
1309
self.finish_request(request, address)
1860
except Exception:
1310
except:
1861
1311
self.handle_error(request, address)
1862
1312
self.close_request(request)
1863
1313
1864
1314
def process_request(self, request, address):
1865
1315
"""Start a new process to process the request."""
1866
proc = multiprocessing.Process(target = self.sub_process_main,
1867
args = (request,
1868
address))
1869
proc.start()
1870
return proc
1871
1316
multiprocessing.Process(target = self.sub_process_main,
1317
args = (request, address)).start()
1872
1318
1873
1319
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1874
1320
""" adds a pipe to the MixIn """
1878
1324
This function creates a new pipe in self.pipe
1879
1325
"""
1880
1326
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1881
1882
proc = MultiprocessingMixIn.process_request(self, request,
1883
client_address)
1884
self.child_pipe.close()
1885
self.add_pipe(parent_pipe, proc)
1886
1887
def add_pipe(self, parent_pipe, proc):
1327
1328
super(MultiprocessingMixInWithPipe,
1329
self).process_request(request, client_address)
1330
self.add_pipe(parent_pipe)
1331
def add_pipe(self, parent_pipe):
1888
1332
"""Dummy function; override as necessary"""
1889
raise NotImplementedError
1890
1333
pass
1891
1334
1892
1335
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1893
1336
socketserver.TCPServer, object):
1911
1354
bind to an address or port if they were not specified."""
1912
1355
if self.interface is not None:
1913
1356
if SO_BINDTODEVICE is None:
1914
logger.error("SO_BINDTODEVICE does not exist;"
1915
" cannot bind to interface %s",
1357
logger.error(u"SO_BINDTODEVICE does not exist;"
1358
u" cannot bind to interface %s",
1916
1359
self.interface)
1917
1360
else:
1918
1361
try:
1919
1362
self.socket.setsockopt(socket.SOL_SOCKET,
1920
1363
SO_BINDTODEVICE,
1921
1364
str(self.interface
1922
+ '\0'))
1923
except socket.error as error:
1365
+ u'\0'))
1366
except socket.error, error:
1924
1367
if error[0] == errno.EPERM:
1925
logger.error("No permission to"
1926
" bind to interface %s",
1368
logger.error(u"No permission to"
1369
u" bind to interface %s",
1927
1370
self.interface)
1928
1371
elif error[0] == errno.ENOPROTOOPT:
1929
logger.error("SO_BINDTODEVICE not available;"
1930
" cannot bind to interface %s",
1372
logger.error(u"SO_BINDTODEVICE not available;"
1373
u" cannot bind to interface %s",
1931
1374
self.interface)
1932
1375
else:
1933
1376
raise
1935
1378
if self.server_address[0] or self.server_address[1]:
1936
1379
if not self.server_address[0]:
1937
1380
if self.address_family == socket.AF_INET6:
1938
any_address = "::" # in6addr_any
1381
any_address = u"::" # in6addr_any
1939
1382
else:
1940
1383
any_address = socket.INADDR_ANY
1941
1384
self.server_address = (any_address,
1968
1411
self.enabled = False
1969
1412
self.clients = clients
1970
1413
if self.clients is None:
1971
self.clients = {}
1414
self.clients = set()
1972
1415
self.use_dbus = use_dbus
1973
1416
self.gnutls_priority = gnutls_priority
1974
1417
IPv6_TCPServer.__init__(self, server_address,
1978
1421
def server_activate(self):
1979
1422
if self.enabled:
1980
1423
return socketserver.TCPServer.server_activate(self)
1981
1982
1424
def enable(self):
1983
1425
self.enabled = True
1984
1985
def add_pipe(self, parent_pipe, proc):
1426
def add_pipe(self, parent_pipe):
1986
1427
# Call "handle_ipc" for both data and EOF events
1987
1428
gobject.io_add_watch(parent_pipe.fileno(),
1988
1429
gobject.IO_IN | gobject.IO_HUP,
1989
1430
functools.partial(self.handle_ipc,
1990
parent_pipe =
1991
parent_pipe,
1992
proc = proc))
1993
1431
parent_pipe = parent_pipe))
1432
1994
1433
def handle_ipc(self, source, condition, parent_pipe=None,
1995
proc = None, client_object=None):
1996
# error, or the other end of multiprocessing.Pipe has closed
1997
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1998
# Wait for other process to exit
1999
proc.join()
2000
return False
1434
client_object=None):
1435
condition_names = {
1436
gobject.IO_IN: u"IN", # There is data to read.
1437
gobject.IO_OUT: u"OUT", # Data can be written (without
1438
# blocking).
1439
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1440
gobject.IO_ERR: u"ERR", # Error condition.
1441
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1442
# broken, usually for pipes and
1443
# sockets).
1444
}
1445
conditions_string = ' | '.join(name
1446
for cond, name in
1447
condition_names.iteritems()
1448
if cond & condition)
1449
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1450
conditions_string)
2001
1451
2002
1452
# Read a request from the child
2003
1453
request = parent_pipe.recv()
2007
1457
fpr = request[1]
2008
1458
address = request[2]
2009
1459
2010
for c in self.clients.itervalues():
1460
for c in self.clients:
2011
1461
if c.fingerprint == fpr:
2012
1462
client = c
2013
1463
break
2014
1464
else:
2015
logger.info("Client not found for fingerprint: %s, ad"
2016
"dress: %s", fpr, address)
1465
logger.warning(u"Client not found for fingerprint: %s, ad"
1466
u"dress: %s", fpr, address)
2017
1467
if self.use_dbus:
2018
1468
# Emit D-Bus signal
2019
mandos_dbus_service.ClientNotFound(fpr,
2020
address[0])
1469
mandos_dbus_service.ClientNotFound(fpr, address)
2021
1470
parent_pipe.send(False)
2022
1471
return False
2023
1472
2024
1473
gobject.io_add_watch(parent_pipe.fileno(),
2025
1474
gobject.IO_IN | gobject.IO_HUP,
2026
1475
functools.partial(self.handle_ipc,
2027
parent_pipe =
2028
parent_pipe,
2029
proc = proc,
2030
client_object =
2031
client))
1476
parent_pipe = parent_pipe,
1477
client_object = client))
2032
1478
parent_pipe.send(True)
2033
# remove the old hook in favor of the new above hook on
2034
# same fileno
1479
# remove the old hook in favor of the new above hook on same fileno
2035
1480
return False
2036
1481
if command == 'funcall':
2037
1482
funcname = request[1]
2038
1483
args = request[2]
2039
1484
kwargs = request[3]
2040
1485
2041
parent_pipe.send(('data', getattr(client_object,
2042
funcname)(*args,
2043
**kwargs)))
2044
1486
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1487
2045
1488
if command == 'getattr':
2046
1489
attrname = request[1]
2047
1490
if callable(client_object.__getattribute__(attrname)):
2048
1491
parent_pipe.send(('function',))
2049
1492
else:
2050
parent_pipe.send(('data', client_object
2051
.__getattribute__(attrname)))
2052
1493
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1494
2053
1495
if command == 'setattr':
2054
1496
attrname = request[1]
2055
1497
value = request[2]
2056
1498
setattr(client_object, attrname, value)
2057
1499
2058
1500
return True
2059
1501
2060
1502
2061
1503
def string_to_delta(interval):
2062
1504
"""Parse a string and return a datetime.timedelta
2063
1505
2064
>>> string_to_delta('7d')
1506
>>> string_to_delta(u'7d')
2065
1507
datetime.timedelta(7)
2066
>>> string_to_delta('60s')
1508
>>> string_to_delta(u'60s')
2067
1509
datetime.timedelta(0, 60)
2068
>>> string_to_delta('60m')
1510
>>> string_to_delta(u'60m')
2069
1511
datetime.timedelta(0, 3600)
2070
>>> string_to_delta('24h')
1512
>>> string_to_delta(u'24h')
2071
1513
datetime.timedelta(1)
2072
>>> string_to_delta('1w')
1514
>>> string_to_delta(u'1w')
2073
1515
datetime.timedelta(7)
2074
>>> string_to_delta('5m 30s')
1516
>>> string_to_delta(u'5m 30s')
2075
1517
datetime.timedelta(0, 330)
2076
1518
"""
2077
1519
timevalue = datetime.timedelta(0)
2079
1521
try:
2080
1522
suffix = unicode(s[-1])
2081
1523
value = int(s[:-1])
2082
if suffix == "d":
1524
if suffix == u"d":
2083
1525
delta = datetime.timedelta(value)
2084
elif suffix == "s":
1526
elif suffix == u"s":
2085
1527
delta = datetime.timedelta(0, value)
2086
elif suffix == "m":
1528
elif suffix == u"m":
2087
1529
delta = datetime.timedelta(0, 0, 0, 0, value)
2088
elif suffix == "h":
1530
elif suffix == u"h":
2089
1531
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2090
elif suffix == "w":
1532
elif suffix == u"w":
2091
1533
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2092
1534
else:
2093
raise ValueError("Unknown suffix {0!r}"
2094
.format(suffix))
2095
except (ValueError, IndexError) as e:
2096
raise ValueError(*(e.args))
1535
raise ValueError(u"Unknown suffix %r" % suffix)
1536
except (ValueError, IndexError), e:
1537
raise ValueError(e.message)
2097
1538
timevalue += delta
2098
1539
return timevalue
2099
1540
2100
1541
1542
def if_nametoindex(interface):
1543
"""Call the C function if_nametoindex(), or equivalent
1544
1545
Note: This function cannot accept a unicode string."""
1546
global if_nametoindex
1547
try:
1548
if_nametoindex = (ctypes.cdll.LoadLibrary
1549
(ctypes.util.find_library(u"c"))
1550
.if_nametoindex)
1551
except (OSError, AttributeError):
1552
logger.warning(u"Doing if_nametoindex the hard way")
1553
def if_nametoindex(interface):
1554
"Get an interface index the hard way, i.e. using fcntl()"
1555
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1556
with contextlib.closing(socket.socket()) as s:
1557
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1558
struct.pack(str(u"16s16x"),
1559
interface))
1560
interface_index = struct.unpack(str(u"I"),
1561
ifreq[16:20])[0]
1562
return interface_index
1563
return if_nametoindex(interface)
1564
1565
2101
1566
def daemon(nochdir = False, noclose = False):
2102
1567
"""See daemon(3). Standard BSD Unix function.
2103
1568
2106
1571
sys.exit()
2107
1572
os.setsid()
2108
1573
if not nochdir:
2109
os.chdir("/")
1574
os.chdir(u"/")
2110
1575
if os.fork():
2111
1576
sys.exit()
2112
1577
if not noclose:
2113
1578
# Close all standard open file descriptors
2114
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1579
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2115
1580
if not stat.S_ISCHR(os.fstat(null).st_mode):
2116
1581
raise OSError(errno.ENODEV,
2117
"{0} not a character device"
2118
.format(os.devnull))
1582
u"%s not a character device"
1583
% os.path.devnull)
2119
1584
os.dup2(null, sys.stdin.fileno())
2120
1585
os.dup2(null, sys.stdout.fileno())
2121
1586
os.dup2(null, sys.stderr.fileno())
2128
1593
##################################################################
2129
1594
# Parsing of options, both command line and config file
2130
1595
2131
parser = argparse.ArgumentParser()
2132
parser.add_argument("-v", "--version", action="version",
2133
version = "%(prog)s {0}".format(version),
2134
help="show version number and exit")
2135
parser.add_argument("-i", "--interface", metavar="IF",
2136
help="Bind to interface IF")
2137
parser.add_argument("-a", "--address",
2138
help="Address to listen for requests on")
2139
parser.add_argument("-p", "--port", type=int,
2140
help="Port number to receive requests on")
2141
parser.add_argument("--check", action="store_true",
2142
help="Run self-test")
2143
parser.add_argument("--debug", action="store_true",
2144
help="Debug mode; run in foreground and log"
2145
" to terminal")
2146
parser.add_argument("--debuglevel", metavar="LEVEL",
2147
help="Debug level for stdout output")
2148
parser.add_argument("--priority", help="GnuTLS"
2149
" priority string (see GnuTLS documentation)")
2150
parser.add_argument("--servicename",
2151
metavar="NAME", help="Zeroconf service name")
2152
parser.add_argument("--configdir",
2153
default="/etc/mandos", metavar="DIR",
2154
help="Directory to search for configuration"
2155
" files")
2156
parser.add_argument("--no-dbus", action="store_false",
2157
dest="use_dbus", help="Do not provide D-Bus"
2158
" system bus interface")
2159
parser.add_argument("--no-ipv6", action="store_false",
2160
dest="use_ipv6", help="Do not use IPv6")
2161
parser.add_argument("--no-restore", action="store_false",
2162
dest="restore", help="Do not restore stored"
2163
" state")
2164
parser.add_argument("--statedir", metavar="DIR",
2165
help="Directory to save/restore state in")
2166
2167
options = parser.parse_args()
1596
parser = optparse.OptionParser(version = "%%prog %s" % version)
1597
parser.add_option("-i", u"--interface", type=u"string",
1598
metavar="IF", help=u"Bind to interface IF")
1599
parser.add_option("-a", u"--address", type=u"string",
1600
help=u"Address to listen for requests on")
1601
parser.add_option("-p", u"--port", type=u"int",
1602
help=u"Port number to receive requests on")
1603
parser.add_option("--check", action=u"store_true",
1604
help=u"Run self-test")
1605
parser.add_option("--debug", action=u"store_true",
1606
help=u"Debug mode; run in foreground and log to"
1607
u" terminal")
1608
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1609
u" priority string (see GnuTLS documentation)")
1610
parser.add_option("--servicename", type=u"string",
1611
metavar=u"NAME", help=u"Zeroconf service name")
1612
parser.add_option("--configdir", type=u"string",
1613
default=u"/etc/mandos", metavar=u"DIR",
1614
help=u"Directory to search for configuration"
1615
u" files")
1616
parser.add_option("--no-dbus", action=u"store_false",
1617
dest=u"use_dbus", help=u"Do not provide D-Bus"
1618
u" system bus interface")
1619
parser.add_option("--no-ipv6", action=u"store_false",
1620
dest=u"use_ipv6", help=u"Do not use IPv6")
1621
options = parser.parse_args()[0]
2168
1622
2169
1623
if options.check:
2170
1624
import doctest
2172
1626
sys.exit()
2173
1627
2174
1628
# Default values for config file for server-global settings
2175
server_defaults = { "interface": "",
2176
"address": "",
2177
"port": "",
2178
"debug": "False",
2179
"priority":
2180
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2181
"servicename": "Mandos",
2182
"use_dbus": "True",
2183
"use_ipv6": "True",
2184
"debuglevel": "",
2185
"restore": "True",
2186
"statedir": "/var/lib/mandos"
1629
server_defaults = { u"interface": u"",
1630
u"address": u"",
1631
u"port": u"",
1632
u"debug": u"False",
1633
u"priority":
1634
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1635
u"servicename": u"Mandos",
1636
u"use_dbus": u"True",
1637
u"use_ipv6": u"True",
2187
1638
}
2188
1639
2189
1640
# Parse config file for server-global settings
2190
1641
server_config = configparser.SafeConfigParser(server_defaults)
2191
1642
del server_defaults
2192
1643
server_config.read(os.path.join(options.configdir,
2193
"mandos.conf"))
1644
u"mandos.conf"))
2194
1645
# Convert the SafeConfigParser object to a dict
2195
1646
server_settings = server_config.defaults()
2196
1647
# Use the appropriate methods on the non-string config options
2197
for option in ("debug", "use_dbus", "use_ipv6"):
2198
server_settings[option] = server_config.getboolean("DEFAULT",
1648
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1649
server_settings[option] = server_config.getboolean(u"DEFAULT",
2199
1650
option)
2200
1651
if server_settings["port"]:
2201
server_settings["port"] = server_config.getint("DEFAULT",
2202
"port")
1652
server_settings["port"] = server_config.getint(u"DEFAULT",
1653
u"port")
2203
1654
del server_config
2204
1655
2205
1656
# Override the settings from the config file with command line
2206
1657
# options, if set.
2207
for option in ("interface", "address", "port", "debug",
2208
"priority", "servicename", "configdir",
2209
"use_dbus", "use_ipv6", "debuglevel", "restore",
2210
"statedir"):
1658
for option in (u"interface", u"address", u"port", u"debug",
1659
u"priority", u"servicename", u"configdir",
1660
u"use_dbus", u"use_ipv6"):
2211
1661
value = getattr(options, option)
2212
1662
if value is not None:
2213
1663
server_settings[option] = value
2221
1671
##################################################################
2222
1672
2223
1673
# For convenience
2224
debug = server_settings["debug"]
2225
debuglevel = server_settings["debuglevel"]
2226
use_dbus = server_settings["use_dbus"]
2227
use_ipv6 = server_settings["use_ipv6"]
2228
stored_state_path = os.path.join(server_settings["statedir"],
2229
stored_state_file)
2230
2231
if debug:
2232
initlogger(debug, logging.DEBUG)
2233
else:
2234
if not debuglevel:
2235
initlogger(debug)
2236
else:
2237
level = getattr(logging, debuglevel.upper())
2238
initlogger(debug, level)
2239
2240
if server_settings["servicename"] != "Mandos":
1674
debug = server_settings[u"debug"]
1675
use_dbus = server_settings[u"use_dbus"]
1676
use_ipv6 = server_settings[u"use_ipv6"]
1677
1678
if not debug:
1679
syslogger.setLevel(logging.WARNING)
1680
console.setLevel(logging.WARNING)
1681
1682
if server_settings[u"servicename"] != u"Mandos":
2241
1683
syslogger.setFormatter(logging.Formatter
2242
('Mandos ({0}) [%(process)d]:'
2243
' %(levelname)s: %(message)s'
2244
.format(server_settings
2245
["servicename"])))
1684
(u'Mandos (%s) [%%(process)d]:'
1685
u' %%(levelname)s: %%(message)s'
1686
% server_settings[u"servicename"]))
2246
1687
2247
1688
# Parse config file with clients
2248
client_config = configparser.SafeConfigParser(Client
2249
.client_defaults)
2250
client_config.read(os.path.join(server_settings["configdir"],
2251
"clients.conf"))
1689
client_defaults = { u"timeout": u"1h",
1690
u"interval": u"5m",
1691
u"checker": u"fping -q -- %%(host)s",
1692
u"host": u"",
1693
u"approved_delay": u"0s",
1694
u"approved_duration": u"1s",
1695
}
1696
client_config = configparser.SafeConfigParser(client_defaults)
1697
client_config.read(os.path.join(server_settings[u"configdir"],
1698
u"clients.conf"))
2252
1699
2253
1700
global mandos_dbus_service
2254
1701
mandos_dbus_service = None
2255
1702
2256
tcp_server = MandosServer((server_settings["address"],
2257
server_settings["port"]),
1703
tcp_server = MandosServer((server_settings[u"address"],
1704
server_settings[u"port"]),
2258
1705
ClientHandler,
2259
interface=(server_settings["interface"]
2260
or None),
1706
interface=server_settings[u"interface"],
2261
1707
use_ipv6=use_ipv6,
2262
1708
gnutls_priority=
2263
server_settings["priority"],
1709
server_settings[u"priority"],
2264
1710
use_dbus=use_dbus)
2265
if not debug:
2266
pidfilename = "/var/run/mandos.pid"
2267
try:
2268
pidfile = open(pidfilename, "w")
2269
except IOError as e:
2270
logger.error("Could not open file %r", pidfilename,
2271
exc_info=e)
1711
pidfilename = u"/var/run/mandos.pid"
1712
try:
1713
pidfile = open(pidfilename, u"w")
1714
except IOError:
1715
logger.error(u"Could not open file %r", pidfilename)
2272
1716
2273
for name in ("_mandos", "mandos", "nobody"):
1717
try:
1718
uid = pwd.getpwnam(u"_mandos").pw_uid
1719
gid = pwd.getpwnam(u"_mandos").pw_gid
1720
except KeyError:
2274
1721
try:
2275
uid = pwd.getpwnam(name).pw_uid
2276
gid = pwd.getpwnam(name).pw_gid
2277
break
1722
uid = pwd.getpwnam(u"mandos").pw_uid
1723
gid = pwd.getpwnam(u"mandos").pw_gid
2278
1724
except KeyError:
2279
continue
2280
else:
2281
uid = 65534
2282
gid = 65534
1725
try:
1726
uid = pwd.getpwnam(u"nobody").pw_uid
1727
gid = pwd.getpwnam(u"nobody").pw_gid
1728
except KeyError:
1729
uid = 65534
1730
gid = 65534
2283
1731
try:
2284
1732
os.setgid(gid)
2285
1733
os.setuid(uid)
2286
except OSError as error:
1734
except OSError, error:
2287
1735
if error[0] != errno.EPERM:
2288
1736
raise error
2289
1737
1738
# Enable all possible GnuTLS debugging
2290
1739
if debug:
2291
# Enable all possible GnuTLS debugging
2292
2293
1740
# "Use a log level over 10 to enable all debugging options."
2294
1741
# - GnuTLS manual
2295
1742
gnutls.library.functions.gnutls_global_set_log_level(11)
2296
1743
2297
1744
@gnutls.library.types.gnutls_log_func
2298
1745
def debug_gnutls(level, string):
2299
logger.debug("GnuTLS: %s", string[:-1])
1746
logger.debug(u"GnuTLS: %s", string[:-1])
2300
1747
2301
1748
(gnutls.library.functions
2302
1749
.gnutls_global_set_log_function(debug_gnutls))
2303
2304
# Redirect stdin so all checkers get /dev/null
2305
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2306
os.dup2(null, sys.stdin.fileno())
2307
if null > 2:
2308
os.close(null)
2309
2310
# Need to fork before connecting to D-Bus
2311
if not debug:
2312
# Close all input and output, do double fork, etc.
2313
daemon()
2314
2315
gobject.threads_init()
2316
1750
2317
1751
global main_loop
2318
1752
# From the Avahi example code
2319
DBusGMainLoop(set_as_default=True)
1753
DBusGMainLoop(set_as_default=True )
2320
1754
main_loop = gobject.MainLoop()
2321
1755
bus = dbus.SystemBus()
2322
1756
# End of Avahi example code
2323
1757
if use_dbus:
2324
1758
try:
2325
bus_name = dbus.service.BusName("se.recompile.Mandos",
1759
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2326
1760
bus, do_not_queue=True)
2327
old_bus_name = (dbus.service.BusName
2328
("se.bsnet.fukt.Mandos", bus,
2329
do_not_queue=True))
2330
except dbus.exceptions.NameExistsException as e:
2331
logger.error("Disabling D-Bus:", exc_info=e)
1761
except dbus.exceptions.NameExistsException, e:
1762
logger.error(unicode(e) + u", disabling D-Bus")
2332
1763
use_dbus = False
2333
server_settings["use_dbus"] = False
1764
server_settings[u"use_dbus"] = False
2334
1765
tcp_server.use_dbus = False
2335
1766
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2336
service = AvahiServiceToSyslog(name =
2337
server_settings["servicename"],
2338
servicetype = "_mandos._tcp",
2339
protocol = protocol, bus = bus)
1767
service = AvahiService(name = server_settings[u"servicename"],
1768
servicetype = u"_mandos._tcp",
1769
protocol = protocol, bus = bus)
2340
1770
if server_settings["interface"]:
2341
1771
service.interface = (if_nametoindex
2342
(str(server_settings["interface"])))
2343
2344
global multiprocessing_manager
2345
multiprocessing_manager = multiprocessing.Manager()
1772
(str(server_settings[u"interface"])))
2346
1773
2347
1774
client_class = Client
2348
1775
if use_dbus:
2349
1776
client_class = functools.partial(ClientDBus, bus = bus)
2350
2351
client_settings = Client.config_parser(client_config)
2352
old_client_settings = {}
2353
clients_data = {}
2354
2355
# Get client data and settings from last running state.
2356
if server_settings["restore"]:
2357
try:
2358
with open(stored_state_path, "rb") as stored_state:
2359
clients_data, old_client_settings = (pickle.load
2360
(stored_state))
2361
os.remove(stored_state_path)
2362
except IOError as e:
2363
if e.errno == errno.ENOENT:
2364
logger.warning("Could not load persistent state: {0}"
2365
.format(os.strerror(e.errno)))
2366
else:
2367
logger.critical("Could not load persistent state:",
2368
exc_info=e)
2369
raise
2370
except EOFError as e:
2371
logger.warning("Could not load persistent state: "
2372
"EOFError:", exc_info=e)
2373
2374
with PGPEngine() as pgp:
2375
for client_name, client in clients_data.iteritems():
2376
# Decide which value to use after restoring saved state.
2377
# We have three different values: Old config file,
2378
# new config file, and saved state.
2379
# New config value takes precedence if it differs from old
2380
# config value, otherwise use saved state.
2381
for name, value in client_settings[client_name].items():
2382
try:
2383
# For each value in new config, check if it
2384
# differs from the old config value (Except for
2385
# the "secret" attribute)
2386
if (name != "secret" and
2387
value != old_client_settings[client_name]
2388
[name]):
2389
client[name] = value
2390
except KeyError:
2391
pass
2392
2393
# Clients who has passed its expire date can still be
2394
# enabled if its last checker was successful. Clients
2395
# whose checker succeeded before we stored its state is
2396
# assumed to have successfully run all checkers during
2397
# downtime.
2398
if client["enabled"]:
2399
if datetime.datetime.utcnow() >= client["expires"]:
2400
if not client["last_checked_ok"]:
2401
logger.warning(
2402
"disabling client {0} - Client never "
2403
"performed a successful checker"
2404
.format(client_name))
2405
client["enabled"] = False
2406
elif client["last_checker_status"] != 0:
2407
logger.warning(
2408
"disabling client {0} - Client "
2409
"last checker failed with error code {1}"
2410
.format(client_name,
2411
client["last_checker_status"]))
2412
client["enabled"] = False
2413
else:
2414
client["expires"] = (datetime.datetime
2415
.utcnow()
2416
+ client["timeout"])
2417
logger.debug("Last checker succeeded,"
2418
" keeping {0} enabled"
2419
.format(client_name))
1777
def client_config_items(config, section):
1778
special_settings = {
1779
"approved_by_default":
1780
lambda: config.getboolean(section,
1781
"approved_by_default"),
1782
}
1783
for name, value in config.items(section):
2420
1784
try:
2421
client["secret"] = (
2422
pgp.decrypt(client["encrypted_secret"],
2423
client_settings[client_name]
2424
["secret"]))
2425
except PGPError:
2426
# If decryption fails, we use secret from new settings
2427
logger.debug("Failed to decrypt {0} old secret"
2428
.format(client_name))
2429
client["secret"] = (
2430
client_settings[client_name]["secret"])
2431
2432
# Add/remove clients based on new changes made to config
2433
for client_name in (set(old_client_settings)
2434
- set(client_settings)):
2435
del clients_data[client_name]
2436
for client_name in (set(client_settings)
2437
- set(old_client_settings)):
2438
clients_data[client_name] = client_settings[client_name]
2439
2440
# Create all client objects
2441
for client_name, client in clients_data.iteritems():
2442
tcp_server.clients[client_name] = client_class(
2443
name = client_name, settings = client)
2444
1785
yield (name, special_settings[name]())
1786
except KeyError:
1787
yield (name, value)
1788
1789
tcp_server.clients.update(set(
1790
client_class(name = section,
1791
config= dict(client_config_items(
1792
client_config, section)))
1793
for section in client_config.sections()))
2445
1794
if not tcp_server.clients:
2446
logger.warning("No clients defined")
1795
logger.warning(u"No clients defined")
1796
1797
if debug:
1798
# Redirect stdin so all checkers get /dev/null
1799
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1800
os.dup2(null, sys.stdin.fileno())
1801
if null > 2:
1802
os.close(null)
1803
else:
1804
# No console logging
1805
logger.removeHandler(console)
1806
# Close all input and output, do double fork, etc.
1807
daemon()
1808
1809
try:
1810
with pidfile:
1811
pid = os.getpid()
1812
pidfile.write(str(pid) + "\n")
1813
del pidfile
1814
except IOError:
1815
logger.error(u"Could not write to file %r with PID %d",
1816
pidfilename, pid)
1817
except NameError:
1818
# "pidfile" was never created
1819
pass
1820
del pidfilename
2447
1821
2448
1822
if not debug:
2449
try:
2450
with pidfile:
2451
pid = os.getpid()
2452
pidfile.write(str(pid) + "\n".encode("utf-8"))
2453
del pidfile
2454
except IOError:
2455
logger.error("Could not write to file %r with PID %d",
2456
pidfilename, pid)
2457
except NameError:
2458
# "pidfile" was never created
2459
pass
2460
del pidfilename
2461
1823
signal.signal(signal.SIGINT, signal.SIG_IGN)
2462
2463
1824
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2464
1825
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2465
1826
2466
1827
if use_dbus:
2467
@alternate_dbus_interfaces({"se.recompile.Mandos":
2468
"se.bsnet.fukt.Mandos"})
2469
class MandosDBusService(DBusObjectWithProperties):
1828
class MandosDBusService(dbus.service.Object):
2470
1829
"""A D-Bus proxy object"""
2471
1830
def __init__(self):
2472
dbus.service.Object.__init__(self, bus, "/")
2473
_interface = "se.recompile.Mandos"
2474
2475
@dbus_interface_annotations(_interface)
2476
def _foo(self):
2477
return { "org.freedesktop.DBus.Property"
2478
".EmitsChangedSignal":
2479
"false"}
2480
2481
@dbus.service.signal(_interface, signature="o")
1831
dbus.service.Object.__init__(self, bus, u"/")
1832
_interface = u"se.bsnet.fukt.Mandos"
1833
1834
@dbus.service.signal(_interface, signature=u"o")
2482
1835
def ClientAdded(self, objpath):
2483
1836
"D-Bus signal"
2484
1837
pass
2485
1838
2486
@dbus.service.signal(_interface, signature="ss")
1839
@dbus.service.signal(_interface, signature=u"ss")
2487
1840
def ClientNotFound(self, fingerprint, address):
2488
1841
"D-Bus signal"
2489
1842
pass
2490
1843
2491
@dbus.service.signal(_interface, signature="os")
1844
@dbus.service.signal(_interface, signature=u"os")
2492
1845
def ClientRemoved(self, objpath, name):
2493
1846
"D-Bus signal"
2494
1847
pass
2495
1848
2496
@dbus.service.method(_interface, out_signature="ao")
1849
@dbus.service.method(_interface, out_signature=u"ao")
2497
1850
def GetAllClients(self):
2498
1851
"D-Bus method"
2499
1852
return dbus.Array(c.dbus_object_path
2500
for c in
2501
tcp_server.clients.itervalues())
1853
for c in tcp_server.clients)
2502
1854
2503
1855
@dbus.service.method(_interface,
2504
out_signature="a{oa{sv}}")
1856
out_signature=u"a{oa{sv}}")
2505
1857
def GetAllClientsWithProperties(self):
2506
1858
"D-Bus method"
2507
1859
return dbus.Dictionary(
2508
((c.dbus_object_path, c.GetAll(""))
2509
for c in tcp_server.clients.itervalues()),
2510
signature="oa{sv}")
1860
((c.dbus_object_path, c.GetAll(u""))
1861
for c in tcp_server.clients),
1862
signature=u"oa{sv}")
2511
1863
2512
@dbus.service.method(_interface, in_signature="o")
1864
@dbus.service.method(_interface, in_signature=u"o")
2513
1865
def RemoveClient(self, object_path):
2514
1866
"D-Bus method"
2515
for c in tcp_server.clients.itervalues():
1867
for c in tcp_server.clients:
2516
1868
if c.dbus_object_path == object_path:
2517
del tcp_server.clients[c.name]
1869
tcp_server.clients.remove(c)
2518
1870
c.remove_from_connection()
2519
1871
# Don't signal anything except ClientRemoved
2520
1872
c.disable(quiet=True)
2531
1883
"Cleanup function; run on exit"
2532
1884
service.cleanup()
2533
1885
2534
multiprocessing.active_children()
2535
if not (tcp_server.clients or client_settings):
2536
return
2537
2538
# Store client before exiting. Secrets are encrypted with key
2539
# based on what config file has. If config file is
2540
# removed/edited, old secret will thus be unrecovable.
2541
clients = {}
2542
with PGPEngine() as pgp:
2543
for client in tcp_server.clients.itervalues():
2544
key = client_settings[client.name]["secret"]
2545
client.encrypted_secret = pgp.encrypt(client.secret,
2546
key)
2547
client_dict = {}
2548
2549
# A list of attributes that can not be pickled
2550
# + secret.
2551
exclude = set(("bus", "changedstate", "secret",
2552
"checker"))
2553
for name, typ in (inspect.getmembers
2554
(dbus.service.Object)):
2555
exclude.add(name)
2556
2557
client_dict["encrypted_secret"] = (client
2558
.encrypted_secret)
2559
for attr in client.client_structure:
2560
if attr not in exclude:
2561
client_dict[attr] = getattr(client, attr)
2562
2563
clients[client.name] = client_dict
2564
del client_settings[client.name]["secret"]
2565
2566
try:
2567
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2568
prefix="clients-",
2569
dir=os.path.dirname
2570
(stored_state_path))
2571
with os.fdopen(tempfd, "wb") as stored_state:
2572
pickle.dump((clients, client_settings), stored_state)
2573
os.rename(tempname, stored_state_path)
2574
except (IOError, OSError) as e:
2575
if not debug:
2576
try:
2577
os.remove(tempname)
2578
except NameError:
2579
pass
2580
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2581
logger.warning("Could not save persistent state: {0}"
2582
.format(os.strerror(e.errno)))
2583
else:
2584
logger.warning("Could not save persistent state:",
2585
exc_info=e)
2586
raise e
2587
2588
# Delete all clients, and settings from config
2589
1886
while tcp_server.clients:
2590
name, client = tcp_server.clients.popitem()
1887
client = tcp_server.clients.pop()
2591
1888
if use_dbus:
2592
1889
client.remove_from_connection()
1890
client.disable_hook = None
2593
1891
# Don't signal anything except ClientRemoved
2594
1892
client.disable(quiet=True)
2595
1893
if use_dbus:
2596
1894
# Emit D-Bus signal
2597
mandos_dbus_service.ClientRemoved(client
2598
.dbus_object_path,
1895
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2599
1896
client.name)
2600
client_settings.clear()
2601
1897
2602
1898
atexit.register(cleanup)
2603
1899
2604
for client in tcp_server.clients.itervalues():
1900
for client in tcp_server.clients:
2605
1901
if use_dbus:
2606
1902
# Emit D-Bus signal
2607
1903
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2608
# Need to initiate checking of clients
2609
if client.enabled:
2610
client.init_checker()
1904
client.enable()
2611
1905
2612
1906
tcp_server.enable()
2613
1907
tcp_server.server_activate()
2615
1909
# Find out what port we got
2616
1910
service.port = tcp_server.socket.getsockname()[1]
2617
1911
if use_ipv6:
2618
logger.info("Now listening on address %r, port %d,"
2619
" flowinfo %d, scope_id %d",
2620
*tcp_server.socket.getsockname())
1912
logger.info(u"Now listening on address %r, port %d,"
1913
" flowinfo %d, scope_id %d"
1914
% tcp_server.socket.getsockname())
2621
1915
else: # IPv4
2622
logger.info("Now listening on address %r, port %d",
2623
*tcp_server.socket.getsockname())
1916
logger.info(u"Now listening on address %r, port %d"
1917
% tcp_server.socket.getsockname())
2624
1918
2625
1919
#service.interface = tcp_server.socket.getsockname()[3]
2626
1920
2628
1922
# From the Avahi example code
2629
1923
try:
2630
1924
service.activate()
2631
except dbus.exceptions.DBusException as error:
2632
logger.critical("D-Bus Exception", exc_info=error)
1925
except dbus.exceptions.DBusException, error:
1926
logger.critical(u"DBusException: %s", error)
2633
1927
cleanup()
2634
1928
sys.exit(1)
2635
1929
# End of Avahi example code
2639
1933
(tcp_server.handle_request
2640
1934
(*args[2:], **kwargs) or True))
2641
1935
2642
logger.debug("Starting main loop")
1936
logger.debug(u"Starting main loop")
2643
1937
main_loop.run()
2644
except AvahiError as error:
2645
logger.critical("Avahi Error", exc_info=error)
1938
except AvahiError, error:
1939
logger.critical(u"AvahiError: %s", error)
2646
1940
cleanup()
2647
1941
sys.exit(1)
2648
1942
except KeyboardInterrupt:
2649
1943
if debug:
2650
print("", file=sys.stderr)
2651
logger.debug("Server received KeyboardInterrupt")
2652
logger.debug("Server exiting")
1944
print >> sys.stderr
1945
logger.debug(u"Server received KeyboardInterrupt")
1946
logger.debug(u"Server exiting")
2653
1947
# Must run before the D-Bus bus name gets deregistered
2654
1948
cleanup()
2655
1949
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0