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