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 410
- compare with another revision
- download diff
- download tarball
- view history from revision 410
- Committer: Teddy Hogeborn
- Date: 2009-11-19 18:31:28 UTC
- Revision ID: teddy@fukt.bsnet.se-20091119183128-ttstewh61xmtnil1
* Makefile (LINK_FORTIFY_LD): Bug fix: removed "-fPIE".
* mandos-keygen: Bug fix: Fix quoting for the "--password" option.
* mandos-keygen: Bug fix: Fix quoting for the "--password" option.
- 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
58
55
import logging
59
56
import logging.handlers
60
57
import pwd
61
import contextlib
58
from contextlib import closing
62
59
import struct
63
60
import fcntl
64
61
import functools
65
import cPickle as pickle
66
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
62
72
63
import dbus
73
64
import dbus.service
78
69
import ctypes.util
79
70
import xml.dom.minidom
80
71
import inspect
81
import GnuPGInterface
82
72
83
73
try:
84
74
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
78
except ImportError:
89
79
SO_BINDTODEVICE = None
90
80
91
version = "1.5.3"
92
stored_state_file = "clients.pickle"
93
94
logger = logging.getLogger()
81
82
version = "1.0.14"
83
84
logger = logging.Logger(u'mandos')
95
85
syslogger = (logging.handlers.SysLogHandler
96
86
(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
87
address = "/dev/log"))
88
syslogger.setFormatter(logging.Formatter
89
(u'Mandos [%(process)d]: %(levelname)s:'
90
u' %(message)s'))
91
logger.addHandler(syslogger)
92
93
console = logging.StreamHandler()
94
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
95
u' %(levelname)s:'
96
u' %(message)s'))
97
logger.addHandler(console)
213
98
214
99
class AvahiError(Exception):
215
100
def __init__(self, value, *args, **kwargs):
231
116
Attributes:
232
117
interface: integer; avahi.IF_UNSPEC or an interface index.
233
118
Used to optionally bind to the specified interface.
234
name: string; Example: 'Mandos'
235
type: string; Example: '_mandos._tcp'.
119
name: string; Example: u'Mandos'
120
type: string; Example: u'_mandos._tcp'.
236
121
See <http://www.dns-sd.org/ServiceTypes.html>
237
122
port: integer; what port to announce
238
123
TXT: list of strings; TXT record for the service
245
130
server: D-Bus Server
246
131
bus: dbus.SystemBus()
247
132
"""
248
249
133
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
250
134
servicetype = None, port = None, TXT = None,
251
domain = "", host = "", max_renames = 32768,
135
domain = u"", host = u"", max_renames = 32768,
252
136
protocol = avahi.PROTO_UNSPEC, bus = None):
253
137
self.interface = interface
254
138
self.name = name
263
147
self.group = None # our entry group
264
148
self.server = None
265
149
self.bus = bus
266
self.entry_group_state_changed_match = None
267
268
150
def rename(self):
269
151
"""Derived from the Avahi example code"""
270
152
if self.rename_count >= self.max_renames:
271
logger.critical("No suitable Zeroconf service name found"
272
" after %i retries, exiting.",
153
logger.critical(u"No suitable Zeroconf service name found"
154
u" after %i retries, exiting.",
273
155
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)
156
raise AvahiServiceError(u"Too many renames")
157
self.name = self.server.GetAlternativeServiceName(self.name)
158
logger.info(u"Changing Zeroconf service name to %r ...",
159
unicode(self.name))
160
syslogger.setFormatter(logging.Formatter
161
(u'Mandos (%s) [%%(process)d]:'
162
u' %%(levelname)s: %%(message)s'
163
% self.name))
279
164
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)
165
self.add()
286
166
self.rename_count += 1
287
288
167
def remove(self):
289
168
"""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
169
if self.group is not None:
294
170
self.group.Reset()
295
296
171
def add(self):
297
172
"""Derived from the Avahi example code"""
298
self.remove()
299
173
if self.group is None:
300
174
self.group = dbus.Interface(
301
175
self.bus.get_object(avahi.DBUS_NAME,
302
176
self.server.EntryGroupNew()),
303
177
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' ...",
178
self.group.connect_to_signal('StateChanged',
179
self
180
.entry_group_state_changed)
181
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
308
182
self.name, self.type)
309
183
self.group.AddService(
310
184
self.interface,
315
189
dbus.UInt16(self.port),
316
190
avahi.string_array_to_txt_array(self.TXT))
317
191
self.group.Commit()
318
319
192
def entry_group_state_changed(self, state, error):
320
193
"""Derived from the Avahi example code"""
321
logger.debug("Avahi entry group state change: %i", state)
194
logger.debug(u"Avahi state change: %i", state)
322
195
323
196
if state == avahi.ENTRY_GROUP_ESTABLISHED:
324
logger.debug("Zeroconf service established.")
197
logger.debug(u"Zeroconf service established.")
325
198
elif state == avahi.ENTRY_GROUP_COLLISION:
326
logger.info("Zeroconf service name collision.")
199
logger.warning(u"Zeroconf service name collision.")
327
200
self.rename()
328
201
elif state == avahi.ENTRY_GROUP_FAILURE:
329
logger.critical("Avahi: Error in group state changed %s",
202
logger.critical(u"Avahi: Error in group state changed %s",
330
203
unicode(error))
331
raise AvahiGroupError("State changed: {0!s}"
332
.format(error))
333
204
raise AvahiGroupError(u"State changed: %s"
205
% unicode(error))
334
206
def cleanup(self):
335
207
"""Derived from the Avahi example code"""
336
208
if self.group is not None:
337
try:
338
self.group.Free()
339
except (dbus.exceptions.UnknownMethodException,
340
dbus.exceptions.DBusException):
341
pass
209
self.group.Free()
342
210
self.group = None
343
self.remove()
344
345
def server_state_changed(self, state, error=None):
211
def server_state_changed(self, state):
346
212
"""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()
213
if state == avahi.SERVER_COLLISION:
214
logger.error(u"Zeroconf server name collision")
215
self.remove()
362
216
elif state == avahi.SERVER_RUNNING:
363
217
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
218
def activate(self):
371
219
"""Derived from the Avahi example code"""
372
220
if self.server is None:
373
221
self.server = dbus.Interface(
374
222
self.bus.get_object(avahi.DBUS_NAME,
375
avahi.DBUS_PATH_SERVER,
376
follow_name_owner_changes=True),
223
avahi.DBUS_PATH_SERVER),
377
224
avahi.DBUS_INTERFACE_SERVER)
378
self.server.connect_to_signal("StateChanged",
225
self.server.connect_to_signal(u"StateChanged",
379
226
self.server_state_changed)
380
227
self.server_state_changed(self.server.GetState())
381
228
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
229
398
230
class Client(object):
399
231
"""A representation of a client host served by this server.
400
232
401
233
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
234
name: string; from the config file, used in log messages and
235
D-Bus identifiers
236
fingerprint: string (40 or 32 hexadecimal digits); used to
237
uniquely identify the client
238
secret: bytestring; sent verbatim (over TLS) to client
239
host: string; available for use by the checker command
240
created: datetime.datetime(); (UTC) object creation
241
last_enabled: datetime.datetime(); (UTC)
242
enabled: bool()
243
last_checked_ok: datetime.datetime(); (UTC) or None
244
timeout: datetime.timedelta(); How long from last_checked_ok
245
until this client is invalid
246
interval: datetime.timedelta(); How often to start a new checker
247
disable_hook: If set, called by disable() as disable_hook(self)
405
248
checker: subprocess.Popen(); a running checker process used
406
249
to see if the client lives.
407
250
'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
251
checker_initiator_tag: a gobject event source tag, or None
252
disable_initiator_tag: - '' -
253
checker_callback_tag: - '' -
254
checker_command: string; External command which is run to check if
255
client lives. %() expansions are done at
411
256
runtime with vars(self) as dict, so that for
412
257
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
258
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
439
259
"""
440
260
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
}
261
@staticmethod
262
def _timedelta_to_milliseconds(td):
263
"Convert a datetime.timedelta() to milliseconds"
264
return ((td.days * 24 * 60 * 60 * 1000)
265
+ (td.seconds * 1000)
266
+ (td.microseconds // 1000))
455
267
456
268
def timeout_milliseconds(self):
457
269
"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)
270
return self._timedelta_to_milliseconds(self.timeout)
463
271
464
272
def interval_milliseconds(self):
465
273
"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):
274
return self._timedelta_to_milliseconds(self.interval)
275
276
def __init__(self, name = None, disable_hook=None, config=None):
277
"""Note: the 'checker' key in 'config' sets the
278
'checker_command' attribute and *not* the 'checker'
279
attribute."""
519
280
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)
281
if config is None:
282
config = {}
283
logger.debug(u"Creating client %r", self.name)
535
284
# Uppercase and remove spaces from fingerprint for later
536
285
# comparison purposes with return value from the fingerprint()
537
286
# 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
287
self.fingerprint = (config[u"fingerprint"].upper()
288
.replace(u" ", u""))
289
logger.debug(u" Fingerprint: %s", self.fingerprint)
290
if u"secret" in config:
291
self.secret = config[u"secret"].decode(u"base64")
292
elif u"secfile" in config:
293
with closing(open(os.path.expanduser
294
(os.path.expandvars
295
(config[u"secfile"])),
296
"rb")) as secfile:
297
self.secret = secfile.read()
298
else:
299
raise TypeError(u"No secret or secfile for client %s"
300
% self.name)
301
self.host = config.get(u"host", u"")
302
self.created = datetime.datetime.utcnow()
303
self.enabled = False
304
self.last_enabled = None
305
self.last_checked_ok = None
306
self.timeout = string_to_delta(config[u"timeout"])
307
self.interval = string_to_delta(config[u"interval"])
308
self.disable_hook = disable_hook
543
309
self.checker = None
544
310
self.checker_initiator_tag = None
545
311
self.disable_initiator_tag = None
546
312
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
547
314
self.current_checker_command = None
548
self.approved = None
549
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
566
def send_changedstate(self):
567
with self.changedstate:
568
self.changedstate.notify_all()
315
self.last_connect = None
569
316
570
317
def enable(self):
571
318
"""Start this client's checker and timeout hooks"""
572
if getattr(self, "enabled", False):
319
if getattr(self, u"enabled", False):
573
320
# Already enabled
574
321
return
575
self.send_changedstate()
576
self.expires = datetime.datetime.utcnow() + self.timeout
577
self.enabled = True
578
322
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
323
# Schedule a new checker to be started an 'interval' from now,
606
324
# and every interval from then on.
607
325
self.checker_initiator_tag = (gobject.timeout_add
611
329
self.disable_initiator_tag = (gobject.timeout_add
612
330
(self.timeout_milliseconds(),
613
331
self.disable))
332
self.enabled = True
614
333
# Also start a new checker *right now*.
615
334
self.start_checker()
616
335
336
def disable(self, quiet=True):
337
"""Disable this client."""
338
if not getattr(self, "enabled", False):
339
return False
340
if not quiet:
341
logger.info(u"Disabling client %s", self.name)
342
if getattr(self, u"disable_initiator_tag", False):
343
gobject.source_remove(self.disable_initiator_tag)
344
self.disable_initiator_tag = None
345
if getattr(self, u"checker_initiator_tag", False):
346
gobject.source_remove(self.checker_initiator_tag)
347
self.checker_initiator_tag = None
348
self.stop_checker()
349
if self.disable_hook:
350
self.disable_hook(self)
351
self.enabled = False
352
# Do not run this again if called by a gobject.timeout_add
353
return False
354
355
def __del__(self):
356
self.disable_hook = None
357
self.disable()
358
617
359
def checker_callback(self, pid, condition, command):
618
360
"""The checker has completed, so take appropriate actions."""
619
361
self.checker_callback_tag = None
620
362
self.checker = None
621
363
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",
364
exitstatus = os.WEXITSTATUS(condition)
365
if exitstatus == 0:
366
logger.info(u"Checker for %(name)s succeeded",
625
367
vars(self))
626
368
self.checked_ok()
627
369
else:
628
logger.info("Checker for %(name)s failed",
370
logger.info(u"Checker for %(name)s failed",
629
371
vars(self))
630
372
else:
631
self.last_checker_status = -1
632
logger.warning("Checker for %(name)s crashed?",
373
logger.warning(u"Checker for %(name)s crashed?",
633
374
vars(self))
634
375
635
376
def checked_ok(self):
636
"""Assert that the client has been seen, alive and well."""
377
"""Bump up the timeout for this client.
378
379
This should only be called when the client has been seen,
380
alive and well.
381
"""
637
382
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()
383
gobject.source_remove(self.disable_initiator_tag)
384
self.disable_initiator_tag = (gobject.timeout_add
385
(self.timeout_milliseconds(),
386
self.disable))
655
387
656
388
def start_checker(self):
657
389
"""Start a new checker subprocess if one is not running.
659
391
If a checker already exists, leave it running and do
660
392
nothing."""
661
393
# 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
394
# did that, then if a checker (for some reason) started
395
# running slowly and taking more than 'interval' time, the
396
# client would inevitably timeout, since no checker would get
397
# a chance to run to completion. If we instead leave running
666
398
# checkers alone, the checker would have to take more time
667
# than 'timeout' for the client to be disabled, which is as it
668
# should be.
399
# than 'timeout' for the client to be declared invalid, which
400
# is as it should be.
669
401
670
402
# If a checker exists, make sure it is not a zombie
671
403
try:
672
404
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
673
except (AttributeError, OSError) as error:
405
except (AttributeError, OSError), error:
674
406
if (isinstance(error, OSError)
675
407
and error.errno != errno.ECHILD):
676
408
raise error
677
409
else:
678
410
if pid:
679
logger.warning("Checker was a zombie")
411
logger.warning(u"Checker was a zombie")
680
412
gobject.source_remove(self.checker_callback_tag)
681
413
self.checker_callback(pid, status,
682
414
self.current_checker_command)
687
419
command = self.checker_command % self.host
688
420
except TypeError:
689
421
# 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
422
escaped_attrs = dict((key,
423
re.escape(unicode(str(val),
424
errors=
425
u'replace')))
426
for key, val in
427
vars(self).iteritems())
698
428
try:
699
429
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)
430
except TypeError, error:
431
logger.error(u'Could not format string "%s":'
432
u' %s', self.checker_command, error)
703
433
return True # Try again later
704
434
self.current_checker_command = command
705
435
try:
706
logger.info("Starting checker %r for %s",
436
logger.info(u"Starting checker %r for %s",
707
437
command, self.name)
708
438
# We don't need to redirect stdout and stderr, since
709
439
# in normal mode, that is already done by daemon(),
711
441
# always replaced by /dev/null.)
712
442
self.checker = subprocess.Popen(command,
713
443
close_fds=True,
714
shell=True, cwd="/")
444
shell=True, cwd=u"/")
715
445
self.checker_callback_tag = (gobject.child_watch_add
716
446
(self.checker.pid,
717
447
self.checker_callback,
722
452
if pid:
723
453
gobject.source_remove(self.checker_callback_tag)
724
454
self.checker_callback(pid, status, command)
725
except OSError as error:
726
logger.error("Failed to start subprocess",
727
exc_info=error)
455
except OSError, error:
456
logger.error(u"Failed to start subprocess: %s",
457
error)
728
458
# Re-run this periodically if run by gobject.timeout_add
729
459
return True
730
460
733
463
if self.checker_callback_tag:
734
464
gobject.source_remove(self.checker_callback_tag)
735
465
self.checker_callback_tag = None
736
if getattr(self, "checker", None) is None:
466
if getattr(self, u"checker", None) is None:
737
467
return
738
logger.debug("Stopping checker for %(name)s", vars(self))
468
logger.debug(u"Stopping checker for %(name)s", vars(self))
739
469
try:
740
self.checker.terminate()
470
os.kill(self.checker.pid, signal.SIGTERM)
741
471
#time.sleep(0.5)
742
472
#if self.checker.poll() is None:
743
# self.checker.kill()
744
except OSError as error:
473
# os.kill(self.checker.pid, signal.SIGKILL)
474
except OSError, error:
745
475
if error.errno != errno.ESRCH: # No such process
746
476
raise
747
477
self.checker = None
748
749
750
def dbus_service_property(dbus_interface, signature="v",
751
access="readwrite", byte_arrays=False):
478
479
def still_valid(self):
480
"""Has the timeout not yet passed for this client?"""
481
if not getattr(self, u"enabled", False):
482
return False
483
now = datetime.datetime.utcnow()
484
if self.last_checked_ok is None:
485
return now < (self.created + self.timeout)
486
else:
487
return now < (self.last_checked_ok + self.timeout)
488
489
490
def dbus_service_property(dbus_interface, signature=u"v",
491
access=u"readwrite", byte_arrays=False):
752
492
"""Decorators for marking methods of a DBusObjectWithProperties to
753
493
become properties on the D-Bus.
754
494
759
499
dbus.service.method, except there is only "signature", since the
760
500
type from Get() and the type sent to Set() is the same.
761
501
"""
762
# Encoding deeply encoded byte arrays is not supported yet by the
763
# "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))
767
502
def decorator(func):
768
503
func._dbus_is_property = True
769
504
func._dbus_interface = dbus_interface
770
505
func._dbus_signature = signature
771
506
func._dbus_access = access
772
507
func._dbus_name = func.__name__
773
if func._dbus_name.endswith("_dbus_property"):
508
if func._dbus_name.endswith(u"_dbus_property"):
774
509
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
510
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
813
511
return func
814
512
return decorator
815
513
835
533
836
534
class DBusObjectWithProperties(dbus.service.Object):
837
535
"""A D-Bus object with properties.
838
536
839
537
Classes inheriting from this can use the dbus_service_property
840
538
decorator to expose methods as D-Bus properties. It exposes the
841
539
standard Get(), Set(), and GetAll() methods on the D-Bus.
842
540
"""
843
541
844
542
@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)
543
def _is_dbus_property(obj):
544
return getattr(obj, u"_dbus_is_property", False)
853
545
854
def _get_all_dbus_things(self, thing):
546
def _get_all_dbus_properties(self):
855
547
"""Returns a generator of (name, attribute) pairs
856
548
"""
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)))
549
return ((prop._dbus_name, prop)
550
for name, prop in
551
inspect.getmembers(self, self._is_dbus_property))
864
552
865
553
def _get_dbus_property(self, interface_name, property_name):
866
554
"""Returns a bound method if one exists which is a D-Bus
867
555
property with the specified name and interface.
868
556
"""
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
557
for name in (property_name,
558
property_name + u"_dbus_property"):
559
prop = getattr(self, name, None)
560
if (prop is None
561
or not self._is_dbus_property(prop)
562
or prop._dbus_name != property_name
563
or (interface_name and prop._dbus_interface
564
and interface_name != prop._dbus_interface)):
565
continue
566
return prop
877
567
# No such property
878
raise DBusPropertyNotFound(self.dbus_object_path + ":"
879
+ interface_name + "."
568
raise DBusPropertyNotFound(self.dbus_object_path + u":"
569
+ interface_name + u"."
880
570
+ property_name)
881
571
882
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
883
out_signature="v")
572
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
573
out_signature=u"v")
884
574
def Get(self, interface_name, property_name):
885
575
"""Standard D-Bus property Get() method, see D-Bus standard.
886
576
"""
887
577
prop = self._get_dbus_property(interface_name, property_name)
888
if prop._dbus_access == "write":
578
if prop._dbus_access == u"write":
889
579
raise DBusPropertyAccessException(property_name)
890
580
value = prop()
891
if not hasattr(value, "variant_level"):
581
if not hasattr(value, u"variant_level"):
892
582
return value
893
583
return type(value)(value, variant_level=value.variant_level+1)
894
584
895
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
585
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
896
586
def Set(self, interface_name, property_name, value):
897
587
"""Standard D-Bus property Set() method, see D-Bus standard.
898
588
"""
899
589
prop = self._get_dbus_property(interface_name, property_name)
900
if prop._dbus_access == "read":
590
if prop._dbus_access == u"read":
901
591
raise DBusPropertyAccessException(property_name)
902
if prop._dbus_get_args_options["byte_arrays"]:
903
# The byte_arrays option is not supported yet on
904
# signatures other than "ay".
905
if prop._dbus_signature != "ay":
906
raise ValueError
907
value = dbus.ByteArray(b''.join(chr(byte)
908
for byte in value))
592
if prop._dbus_get_args_options[u"byte_arrays"]:
593
value = dbus.ByteArray(''.join(unichr(byte)
594
for byte in value))
909
595
prop(value)
910
596
911
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
912
out_signature="a{sv}")
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
598
out_signature=u"a{sv}")
913
599
def GetAll(self, interface_name):
914
600
"""Standard D-Bus property GetAll() method, see D-Bus
915
601
standard.
916
602
917
603
Note: Will not include properties with access="write".
918
604
"""
919
properties = {}
920
for name, prop in self._get_all_dbus_things("property"):
605
all = {}
606
for name, prop in self._get_all_dbus_properties():
921
607
if (interface_name
922
608
and interface_name != prop._dbus_interface):
923
609
# Interface non-empty but did not match
924
610
continue
925
611
# Ignore write-only properties
926
if prop._dbus_access == "write":
612
if prop._dbus_access == u"write":
927
613
continue
928
614
value = prop()
929
if not hasattr(value, "variant_level"):
930
properties[name] = value
615
if not hasattr(value, u"variant_level"):
616
all[name] = value
931
617
continue
932
properties[name] = type(value)(value, variant_level=
933
value.variant_level+1)
934
return dbus.Dictionary(properties, signature="sv")
618
all[name] = type(value)(value, variant_level=
619
value.variant_level+1)
620
return dbus.Dictionary(all, signature=u"sv")
935
621
936
622
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
937
out_signature="s",
623
out_signature=u"s",
938
624
path_keyword='object_path',
939
625
connection_keyword='connection')
940
626
def Introspect(self, object_path, connection):
941
"""Overloading of standard D-Bus method.
942
943
Inserts property tags and interface annotation tags.
627
"""Standard D-Bus method, overloaded to insert property tags.
944
628
"""
945
629
xmlstring = dbus.service.Object.Introspect(self, object_path,
946
630
connection)
947
631
try:
948
632
document = xml.dom.minidom.parseString(xmlstring)
949
633
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)
634
e = document.createElement(u"property")
635
e.setAttribute(u"name", name)
636
e.setAttribute(u"type", prop._dbus_signature)
637
e.setAttribute(u"access", prop._dbus_access)
954
638
return e
955
for if_tag in document.getElementsByTagName("interface"):
956
# Add property tags
639
for if_tag in document.getElementsByTagName(u"interface"):
957
640
for tag in (make_tag(document, name, prop)
958
641
for name, prop
959
in self._get_all_dbus_things("property")
642
in self._get_all_dbus_properties()
960
643
if prop._dbus_interface
961
== if_tag.getAttribute("name")):
644
== if_tag.getAttribute(u"name")):
962
645
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
646
# Add the names to the return values for the
995
647
# "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")
648
if (if_tag.getAttribute(u"name")
649
== u"org.freedesktop.DBus.Properties"):
650
for cn in if_tag.getElementsByTagName(u"method"):
651
if cn.getAttribute(u"name") == u"Get":
652
for arg in cn.getElementsByTagName(u"arg"):
653
if (arg.getAttribute(u"direction")
654
== u"out"):
655
arg.setAttribute(u"name", u"value")
656
elif cn.getAttribute(u"name") == u"GetAll":
657
for arg in cn.getElementsByTagName(u"arg"):
658
if (arg.getAttribute(u"direction")
659
== u"out"):
660
arg.setAttribute(u"name", u"props")
661
xmlstring = document.toxml(u"utf-8")
1010
662
document.unlink()
1011
663
except (AttributeError, xml.dom.DOMException,
1012
xml.parsers.expat.ExpatError) as error:
1013
logger.error("Failed to override Introspection method",
1014
exc_info=error)
664
xml.parsers.expat.ExpatError), error:
665
logger.error(u"Failed to override Introspection method",
666
error)
1015
667
return xmlstring
1016
668
1017
669
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
670
class ClientDBus(Client, DBusObjectWithProperties):
1198
671
"""A Client class using D-Bus
1199
672
1201
674
dbus_object_path: dbus.ObjectPath
1202
675
bus: dbus.SystemBus()
1203
676
"""
1204
1205
runtime_expansions = (Client.runtime_expansions
1206
+ ("dbus_object_path",))
1207
1208
677
# dbus.service.Object doesn't use super(), so we can't either.
1209
678
1210
679
def __init__(self, bus = None, *args, **kwargs):
1212
681
Client.__init__(self, *args, **kwargs)
1213
682
# Only now, when this client is initialized, can it show up on
1214
683
# the D-Bus
1215
client_object_name = unicode(self.name).translate(
1216
{ord("."): ord("_"),
1217
ord("-"): ord("_")})
1218
684
self.dbus_object_path = (dbus.ObjectPath
1219
("/clients/" + client_object_name))
685
(u"/clients/"
686
+ self.name.replace(u".", u"_")))
1220
687
DBusObjectWithProperties.__init__(self, self.bus,
1221
688
self.dbus_object_path)
1222
689
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
690
@staticmethod
691
def _datetime_to_dbus(dt, variant_level=0):
692
"""Convert a UTC datetime.datetime() to a D-Bus type."""
693
return dbus.String(dt.isoformat(),
694
variant_level=variant_level)
695
696
def enable(self):
697
oldstate = getattr(self, u"enabled", False)
698
r = Client.enable(self)
699
if oldstate != self.enabled:
700
# Emit D-Bus signals
701
self.PropertyChanged(dbus.String(u"enabled"),
702
dbus.Boolean(True, variant_level=1))
703
self.PropertyChanged(
704
dbus.String(u"last_enabled"),
705
self._datetime_to_dbus(self.last_enabled,
706
variant_level=1))
707
return r
708
709
def disable(self, quiet = False):
710
oldstate = getattr(self, u"enabled", False)
711
r = Client.disable(self, quiet=quiet)
712
if not quiet and oldstate != self.enabled:
713
# Emit D-Bus signal
714
self.PropertyChanged(dbus.String(u"enabled"),
715
dbus.Boolean(False, variant_level=1))
716
return r
1290
717
1291
718
def __del__(self, *args, **kwargs):
1292
719
try:
1293
720
self.remove_from_connection()
1294
721
except LookupError:
1295
722
pass
1296
if hasattr(DBusObjectWithProperties, "__del__"):
723
if hasattr(DBusObjectWithProperties, u"__del__"):
1297
724
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1298
725
Client.__del__(self, *args, **kwargs)
1299
726
1301
728
*args, **kwargs):
1302
729
self.checker_callback_tag = None
1303
730
self.checker = None
731
# Emit D-Bus signal
732
self.PropertyChanged(dbus.String(u"checker_running"),
733
dbus.Boolean(False, variant_level=1))
1304
734
if os.WIFEXITED(condition):
1305
735
exitstatus = os.WEXITSTATUS(condition)
1306
736
# Emit D-Bus signal
1316
746
return Client.checker_callback(self, pid, condition, command,
1317
747
*args, **kwargs)
1318
748
749
def checked_ok(self, *args, **kwargs):
750
r = Client.checked_ok(self, *args, **kwargs)
751
# Emit D-Bus signal
752
self.PropertyChanged(
753
dbus.String(u"last_checked_ok"),
754
(self._datetime_to_dbus(self.last_checked_ok,
755
variant_level=1)))
756
return r
757
1319
758
def start_checker(self, *args, **kwargs):
1320
759
old_checker = self.checker
1321
760
if self.checker is not None:
1328
767
and old_checker_pid != self.checker.pid):
1329
768
# Emit D-Bus signal
1330
769
self.CheckerStarted(self.current_checker_command)
1331
return r
1332
1333
def _reset_approved(self):
1334
self.approved = None
1335
return False
1336
1337
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)
1343
1344
## 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"}
1353
1354
## Signals
770
self.PropertyChanged(
771
dbus.String(u"checker_running"),
772
dbus.Boolean(True, variant_level=1))
773
return r
774
775
def stop_checker(self, *args, **kwargs):
776
old_checker = getattr(self, u"checker", None)
777
r = Client.stop_checker(self, *args, **kwargs)
778
if (old_checker is not None
779
and getattr(self, u"checker", None) is None):
780
self.PropertyChanged(dbus.String(u"checker_running"),
781
dbus.Boolean(False, variant_level=1))
782
return r
783
784
## D-Bus methods & signals
785
_interface = u"se.bsnet.fukt.Mandos.Client"
786
787
# CheckedOK - method
788
@dbus.service.method(_interface)
789
def CheckedOK(self):
790
return self.checked_ok()
1355
791
1356
792
# CheckerCompleted - signal
1357
@dbus.service.signal(_interface, signature="nxs")
793
@dbus.service.signal(_interface, signature=u"nxs")
1358
794
def CheckerCompleted(self, exitcode, waitstatus, command):
1359
795
"D-Bus signal"
1360
796
pass
1361
797
1362
798
# CheckerStarted - signal
1363
@dbus.service.signal(_interface, signature="s")
799
@dbus.service.signal(_interface, signature=u"s")
1364
800
def CheckerStarted(self, command):
1365
801
"D-Bus signal"
1366
802
pass
1367
803
1368
804
# PropertyChanged - signal
1369
@dbus.service.signal(_interface, signature="sv")
805
@dbus.service.signal(_interface, signature=u"sv")
1370
806
def PropertyChanged(self, property, value):
1371
807
"D-Bus signal"
1372
808
pass
1374
810
# GotSecret - signal
1375
811
@dbus.service.signal(_interface)
1376
812
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
"""
813
"D-Bus signal"
1381
814
pass
1382
815
1383
816
# Rejected - signal
1384
@dbus.service.signal(_interface, signature="s")
1385
def Rejected(self, reason):
817
@dbus.service.signal(_interface)
818
def Rejected(self):
1386
819
"D-Bus signal"
1387
820
pass
1388
821
1389
# NeedApproval - signal
1390
@dbus.service.signal(_interface, signature="tb")
1391
def NeedApproval(self, timeout, default):
1392
"D-Bus signal"
1393
return self.need_approval()
1394
1395
## Methods
1396
1397
# Approve - method
1398
@dbus.service.method(_interface, in_signature="b")
1399
def Approve(self, value):
1400
self.approve(value)
1401
1402
# CheckedOK - method
1403
@dbus.service.method(_interface)
1404
def CheckedOK(self):
1405
self.checked_ok()
1406
1407
822
# Enable - method
1408
823
@dbus.service.method(_interface)
1409
824
def Enable(self):
1427
842
def StopChecker(self):
1428
843
self.stop_checker()
1429
844
1430
## Properties
1431
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):
845
# name - property
846
@dbus_service_property(_interface, signature=u"s", access=u"read")
847
def name_dbus_property(self):
1465
848
return dbus.String(self.name)
1466
849
1467
# Fingerprint - property
1468
@dbus_service_property(_interface, signature="s", access="read")
1469
def Fingerprint_dbus_property(self):
850
# fingerprint - property
851
@dbus_service_property(_interface, signature=u"s", access=u"read")
852
def fingerprint_dbus_property(self):
1470
853
return dbus.String(self.fingerprint)
1471
854
1472
# Host - property
1473
@dbus_service_property(_interface, signature="s",
1474
access="readwrite")
1475
def Host_dbus_property(self, value=None):
855
# host - property
856
@dbus_service_property(_interface, signature=u"s",
857
access=u"readwrite")
858
def host_dbus_property(self, value=None):
1476
859
if value is None: # get
1477
860
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):
861
self.host = value
862
# Emit D-Bus signal
863
self.PropertyChanged(dbus.String(u"host"),
864
dbus.String(value, variant_level=1))
865
866
# created - property
867
@dbus_service_property(_interface, signature=u"s", access=u"read")
868
def created_dbus_property(self):
869
return dbus.String(self._datetime_to_dbus(self.created))
870
871
# last_enabled - property
872
@dbus_service_property(_interface, signature=u"s", access=u"read")
873
def last_enabled_dbus_property(self):
874
if self.last_enabled is None:
875
return dbus.String(u"")
876
return dbus.String(self._datetime_to_dbus(self.last_enabled))
877
878
# enabled - property
879
@dbus_service_property(_interface, signature=u"b",
880
access=u"readwrite")
881
def enabled_dbus_property(self, value=None):
1494
882
if value is None: # get
1495
883
return dbus.Boolean(self.enabled)
1496
884
if value:
1498
886
else:
1499
887
self.disable()
1500
888
1501
# LastCheckedOK - property
1502
@dbus_service_property(_interface, signature="s",
1503
access="readwrite")
1504
def LastCheckedOK_dbus_property(self, value=None):
889
# last_checked_ok - property
890
@dbus_service_property(_interface, signature=u"s",
891
access=u"readwrite")
892
def last_checked_ok_dbus_property(self, value=None):
1505
893
if value is not None:
1506
894
self.checked_ok()
1507
895
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):
896
if self.last_checked_ok is None:
897
return dbus.String(u"")
898
return dbus.String(self._datetime_to_dbus(self
899
.last_checked_ok))
900
901
# timeout - property
902
@dbus_service_property(_interface, signature=u"t",
903
access=u"readwrite")
904
def timeout_dbus_property(self, value=None):
1530
905
if value is None: # get
1531
906
return dbus.UInt64(self.timeout_milliseconds())
1532
907
self.timeout = datetime.timedelta(0, 0, 0, value)
908
# Emit D-Bus signal
909
self.PropertyChanged(dbus.String(u"timeout"),
910
dbus.UInt64(value, variant_level=1))
911
if getattr(self, u"disable_initiator_tag", None) is None:
912
return
1533
913
# 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):
914
gobject.source_remove(self.disable_initiator_tag)
915
self.disable_initiator_tag = None
916
time_to_die = (self.
917
_timedelta_to_milliseconds((self
918
.last_checked_ok
919
+ self.timeout)
920
- datetime.datetime
921
.utcnow()))
922
if time_to_die <= 0:
923
# The timeout has passed
924
self.disable()
925
else:
926
self.disable_initiator_tag = (gobject.timeout_add
927
(time_to_die, self.disable))
928
929
# interval - property
930
@dbus_service_property(_interface, signature=u"t",
931
access=u"readwrite")
932
def interval_dbus_property(self, value=None):
1565
933
if value is None: # get
1566
934
return dbus.UInt64(self.interval_milliseconds())
1567
935
self.interval = datetime.timedelta(0, 0, 0, value)
1568
if getattr(self, "checker_initiator_tag", None) is None:
936
# Emit D-Bus signal
937
self.PropertyChanged(dbus.String(u"interval"),
938
dbus.UInt64(value, variant_level=1))
939
if getattr(self, u"checker_initiator_tag", None) is None:
1569
940
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):
941
# Reschedule checker run
942
gobject.source_remove(self.checker_initiator_tag)
943
self.checker_initiator_tag = (gobject.timeout_add
944
(value, self.start_checker))
945
self.start_checker() # Start one now, too
946
947
# checker - property
948
@dbus_service_property(_interface, signature=u"s",
949
access=u"readwrite")
950
def checker_dbus_property(self, value=None):
1581
951
if value is None: # get
1582
952
return dbus.String(self.checker_command)
1583
self.checker_command = unicode(value)
953
self.checker_command = value
954
# Emit D-Bus signal
955
self.PropertyChanged(dbus.String(u"checker"),
956
dbus.String(self.checker_command,
957
variant_level=1))
1584
958
1585
# CheckerRunning - property
1586
@dbus_service_property(_interface, signature="b",
1587
access="readwrite")
1588
def CheckerRunning_dbus_property(self, value=None):
959
# checker_running - property
960
@dbus_service_property(_interface, signature=u"b",
961
access=u"readwrite")
962
def checker_running_dbus_property(self, value=None):
1589
963
if value is None: # get
1590
964
return dbus.Boolean(self.checker is not None)
1591
965
if value:
1593
967
else:
1594
968
self.stop_checker()
1595
969
1596
# ObjectPath - property
1597
@dbus_service_property(_interface, signature="o", access="read")
1598
def ObjectPath_dbus_property(self):
970
# object_path - property
971
@dbus_service_property(_interface, signature=u"o", access=u"read")
972
def object_path_dbus_property(self):
1599
973
return self.dbus_object_path # is already a dbus.ObjectPath
1600
974
1601
# Secret = property
1602
@dbus_service_property(_interface, signature="ay",
1603
access="write", byte_arrays=True)
1604
def Secret_dbus_property(self, value):
975
# secret = property
976
@dbus_service_property(_interface, signature=u"ay",
977
access=u"write", byte_arrays=True)
978
def secret_dbus_property(self, value):
1605
979
self.secret = str(value)
1606
980
1607
981
del _interface
1608
982
1609
983
1610
class ProxyClient(object):
1611
def __init__(self, child_pipe, fpr, address):
1612
self._pipe = child_pipe
1613
self._pipe.send(('init', fpr, address))
1614
if not self._pipe.recv():
1615
raise KeyError()
1616
1617
def __getattribute__(self, name):
1618
if name == '_pipe':
1619
return super(ProxyClient, self).__getattribute__(name)
1620
self._pipe.send(('getattr', name))
1621
data = self._pipe.recv()
1622
if data[0] == 'data':
1623
return data[1]
1624
if data[0] == 'function':
1625
def func(*args, **kwargs):
1626
self._pipe.send(('funcall', name, args, kwargs))
1627
return self._pipe.recv()[1]
1628
return func
1629
1630
def __setattr__(self, name, value):
1631
if name == '_pipe':
1632
return super(ProxyClient, self).__setattr__(name, value)
1633
self._pipe.send(('setattr', name, value))
1634
1635
1636
984
class ClientHandler(socketserver.BaseRequestHandler, object):
1637
985
"""A class to handle client connections.
1638
986
1640
988
Note: This will run in its own forked process."""
1641
989
1642
990
def handle(self):
1643
with contextlib.closing(self.server.child_pipe) as child_pipe:
1644
logger.info("TCP connection from: %s",
1645
unicode(self.client_address))
1646
logger.debug("Pipe FD: %d",
1647
self.server.child_pipe.fileno())
1648
991
logger.info(u"TCP connection from: %s",
992
unicode(self.client_address))
993
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
994
# Open IPC pipe to parent process
995
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
1649
996
session = (gnutls.connection
1650
997
.ClientSession(self.request,
1651
998
gnutls.connection
1652
999
.X509Credentials()))
1653
1000
1001
line = self.request.makefile().readline()
1002
logger.debug(u"Protocol version: %r", line)
1003
try:
1004
if int(line.strip().split()[0]) > 1:
1005
raise RuntimeError
1006
except (ValueError, IndexError, RuntimeError), error:
1007
logger.error(u"Unknown protocol version: %s", error)
1008
return
1009
1654
1010
# Note: gnutls.connection.X509Credentials is really a
1655
1011
# generic GnuTLS certificate credentials object so long as
1656
1012
# no X.509 keys are added to it. Therefore, we can use it
1657
1013
# here despite using OpenPGP certificates.
1658
1014
1659
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1660
# "+AES-256-CBC", "+SHA1",
1661
# "+COMP-NULL", "+CTYPE-OPENPGP",
1662
# "+DHE-DSS"))
1015
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1016
# u"+AES-256-CBC", u"+SHA1",
1017
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1018
# u"+DHE-DSS"))
1663
1019
# Use a fallback default, since this MUST be set.
1664
1020
priority = self.server.gnutls_priority
1665
1021
if priority is None:
1666
priority = "NORMAL"
1022
priority = u"NORMAL"
1667
1023
(gnutls.library.functions
1668
1024
.gnutls_priority_set_direct(session._c_object,
1669
1025
priority, None))
1670
1026
1671
# Start communication using the Mandos protocol
1672
# Get protocol number
1673
line = self.request.makefile().readline()
1674
logger.debug("Protocol version: %r", line)
1675
try:
1676
if int(line.strip().split()[0]) > 1:
1677
raise RuntimeError
1678
except (ValueError, IndexError, RuntimeError) as error:
1679
logger.error("Unknown protocol version: %s", error)
1680
return
1681
1682
# Start GnuTLS connection
1683
1027
try:
1684
1028
session.handshake()
1685
except gnutls.errors.GNUTLSError as error:
1686
logger.warning("Handshake failed: %s", error)
1029
except gnutls.errors.GNUTLSError, error:
1030
logger.warning(u"Handshake failed: %s", error)
1687
1031
# Do not run session.bye() here: the session is not
1688
1032
# established. Just abandon the request.
1689
1033
return
1690
logger.debug("Handshake succeeded")
1691
1692
approval_required = False
1034
logger.debug(u"Handshake succeeded")
1693
1035
try:
1694
try:
1695
fpr = self.fingerprint(self.peer_certificate
1696
(session))
1697
except (TypeError,
1698
gnutls.errors.GNUTLSError) as error:
1699
logger.warning("Bad certificate: %s", error)
1700
return
1701
logger.debug("Fingerprint: %s", fpr)
1702
1703
try:
1704
client = ProxyClient(child_pipe, fpr,
1705
self.client_address)
1706
except KeyError:
1707
return
1708
1709
if client.approval_delay:
1710
delay = client.approval_delay
1711
client.approvals_pending += 1
1712
approval_required = True
1713
1714
while True:
1715
if not client.enabled:
1716
logger.info("Client %s is disabled",
1717
client.name)
1718
if self.server.use_dbus:
1719
# Emit D-Bus signal
1720
client.Rejected("Disabled")
1721
return
1722
1723
if client.approved or not client.approval_delay:
1724
#We are approved or approval is disabled
1725
break
1726
elif client.approved is None:
1727
logger.info("Client %s needs approval",
1728
client.name)
1729
if self.server.use_dbus:
1730
# Emit D-Bus signal
1731
client.NeedApproval(
1732
client.approval_delay_milliseconds(),
1733
client.approved_by_default)
1734
else:
1735
logger.warning("Client %s was not approved",
1736
client.name)
1737
if self.server.use_dbus:
1738
# Emit D-Bus signal
1739
client.Rejected("Denied")
1740
return
1741
1742
#wait until timeout or approved
1743
time = datetime.datetime.now()
1744
client.changedstate.acquire()
1745
(client.changedstate.wait
1746
(float(client.timedelta_to_milliseconds(delay)
1747
/ 1000)))
1748
client.changedstate.release()
1749
time2 = datetime.datetime.now()
1750
if (time2 - time) >= delay:
1751
if not client.approved_by_default:
1752
logger.warning("Client %s timed out while"
1753
" waiting for approval",
1754
client.name)
1755
if self.server.use_dbus:
1756
# Emit D-Bus signal
1757
client.Rejected("Approval timed out")
1758
return
1759
else:
1760
break
1761
else:
1762
delay -= time2 - time
1763
1764
sent_size = 0
1765
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",
1773
sent, len(client.secret)
1774
- (sent_size + sent))
1775
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)
1780
if self.server.use_dbus:
1781
# Emit D-Bus signal
1782
client.GotSecret()
1036
fpr = self.fingerprint(self.peer_certificate(session))
1037
except (TypeError, gnutls.errors.GNUTLSError), error:
1038
logger.warning(u"Bad certificate: %s", error)
1039
session.bye()
1040
return
1041
logger.debug(u"Fingerprint: %s", fpr)
1783
1042
1784
finally:
1785
if approval_required:
1786
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)
1043
for c in self.server.clients:
1044
if c.fingerprint == fpr:
1045
client = c
1046
break
1047
else:
1048
ipc.write(u"NOTFOUND %s %s\n"
1049
% (fpr, unicode(self.client_address)))
1050
session.bye()
1051
return
1052
# Have to check if client.still_valid(), since it is
1053
# possible that the client timed out while establishing
1054
# the GnuTLS session.
1055
if not client.still_valid():
1056
ipc.write(u"INVALID %s\n" % client.name)
1057
session.bye()
1058
return
1059
ipc.write(u"SENDING %s\n" % client.name)
1060
sent_size = 0
1061
while sent_size < len(client.secret):
1062
sent = session.send(client.secret[sent_size:])
1063
logger.debug(u"Sent: %d, remaining: %d",
1064
sent, len(client.secret)
1065
- (sent_size + sent))
1066
sent_size += sent
1067
session.bye()
1792
1068
1793
1069
@staticmethod
1794
1070
def peer_certificate(session):
1804
1080
.gnutls_certificate_get_peers
1805
1081
(session._c_object, ctypes.byref(list_size)))
1806
1082
if not bool(cert_list) and list_size.value != 0:
1807
raise gnutls.errors.GNUTLSError("error getting peer"
1808
" certificate")
1083
raise gnutls.errors.GNUTLSError(u"error getting peer"
1084
u" certificate")
1809
1085
if list_size.value == 0:
1810
1086
return None
1811
1087
cert = cert_list[0]
1837
1113
if crtverify.value != 0:
1838
1114
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1839
1115
raise (gnutls.errors.CertificateSecurityError
1840
("Verify failed"))
1116
(u"Verify failed"))
1841
1117
# New buffer for the fingerprint
1842
1118
buf = ctypes.create_string_buffer(20)
1843
1119
buf_len = ctypes.c_size_t()
1850
1126
# Convert the buffer to a Python bytestring
1851
1127
fpr = ctypes.string_at(buf, buf_len.value)
1852
1128
# Convert the bytestring to hexadecimal notation
1853
hex_fpr = binascii.hexlify(fpr).upper()
1129
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1854
1130
return hex_fpr
1855
1131
1856
1132
1857
class MultiprocessingMixIn(object):
1858
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1859
def sub_process_main(self, request, address):
1860
try:
1861
self.finish_request(request, address)
1862
except Exception:
1863
self.handle_error(request, address)
1864
self.close_request(request)
1865
1866
def process_request(self, request, address):
1867
"""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
1873
1874
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1875
""" adds a pipe to the MixIn """
1133
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1134
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
1876
1135
def process_request(self, request, client_address):
1877
1136
"""Overrides and wraps the original process_request().
1878
1137
1879
1138
This function creates a new pipe in self.pipe
1880
1139
"""
1881
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):
1140
self.pipe = os.pipe()
1141
super(ForkingMixInWithPipe,
1142
self).process_request(request, client_address)
1143
os.close(self.pipe[1]) # close write end
1144
self.add_pipe(self.pipe[0])
1145
def add_pipe(self, pipe):
1889
1146
"""Dummy function; override as necessary"""
1890
raise NotImplementedError
1891
1892
1893
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1147
os.close(pipe)
1148
1149
1150
class IPv6_TCPServer(ForkingMixInWithPipe,
1894
1151
socketserver.TCPServer, object):
1895
1152
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1896
1153
1912
1169
bind to an address or port if they were not specified."""
1913
1170
if self.interface is not None:
1914
1171
if SO_BINDTODEVICE is None:
1915
logger.error("SO_BINDTODEVICE does not exist;"
1916
" cannot bind to interface %s",
1172
logger.error(u"SO_BINDTODEVICE does not exist;"
1173
u" cannot bind to interface %s",
1917
1174
self.interface)
1918
1175
else:
1919
1176
try:
1920
1177
self.socket.setsockopt(socket.SOL_SOCKET,
1921
1178
SO_BINDTODEVICE,
1922
1179
str(self.interface
1923
+ '\0'))
1924
except socket.error as error:
1180
+ u'\0'))
1181
except socket.error, error:
1925
1182
if error[0] == errno.EPERM:
1926
logger.error("No permission to"
1927
" bind to interface %s",
1183
logger.error(u"No permission to"
1184
u" bind to interface %s",
1928
1185
self.interface)
1929
1186
elif error[0] == errno.ENOPROTOOPT:
1930
logger.error("SO_BINDTODEVICE not available;"
1931
" cannot bind to interface %s",
1187
logger.error(u"SO_BINDTODEVICE not available;"
1188
u" cannot bind to interface %s",
1932
1189
self.interface)
1933
1190
else:
1934
1191
raise
1936
1193
if self.server_address[0] or self.server_address[1]:
1937
1194
if not self.server_address[0]:
1938
1195
if self.address_family == socket.AF_INET6:
1939
any_address = "::" # in6addr_any
1196
any_address = u"::" # in6addr_any
1940
1197
else:
1941
1198
any_address = socket.INADDR_ANY
1942
1199
self.server_address = (any_address,
1969
1226
self.enabled = False
1970
1227
self.clients = clients
1971
1228
if self.clients is None:
1972
self.clients = {}
1229
self.clients = set()
1973
1230
self.use_dbus = use_dbus
1974
1231
self.gnutls_priority = gnutls_priority
1975
1232
IPv6_TCPServer.__init__(self, server_address,
1979
1236
def server_activate(self):
1980
1237
if self.enabled:
1981
1238
return socketserver.TCPServer.server_activate(self)
1982
1983
1239
def enable(self):
1984
1240
self.enabled = True
1985
1986
def add_pipe(self, parent_pipe, proc):
1241
def add_pipe(self, pipe):
1987
1242
# Call "handle_ipc" for both data and EOF events
1988
gobject.io_add_watch(parent_pipe.fileno(),
1989
gobject.IO_IN | gobject.IO_HUP,
1990
functools.partial(self.handle_ipc,
1991
parent_pipe =
1992
parent_pipe,
1993
proc = proc))
1994
1995
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
2002
2003
# Read a request from the child
2004
request = parent_pipe.recv()
2005
command = request[0]
2006
2007
if command == 'init':
2008
fpr = request[1]
2009
address = request[2]
2010
2011
for c in self.clients.itervalues():
2012
if c.fingerprint == fpr:
2013
client = c
2014
break
2015
else:
2016
logger.info("Client not found for fingerprint: %s, ad"
2017
"dress: %s", fpr, address)
2018
if self.use_dbus:
2019
# Emit D-Bus signal
2020
mandos_dbus_service.ClientNotFound(fpr,
2021
address[0])
2022
parent_pipe.send(False)
2023
return False
2024
2025
gobject.io_add_watch(parent_pipe.fileno(),
2026
gobject.IO_IN | gobject.IO_HUP,
2027
functools.partial(self.handle_ipc,
2028
parent_pipe =
2029
parent_pipe,
2030
proc = proc,
2031
client_object =
2032
client))
2033
parent_pipe.send(True)
2034
# remove the old hook in favor of the new above hook on
2035
# same fileno
2036
return False
2037
if command == 'funcall':
2038
funcname = request[1]
2039
args = request[2]
2040
kwargs = request[3]
2041
2042
parent_pipe.send(('data', getattr(client_object,
2043
funcname)(*args,
2044
**kwargs)))
2045
2046
if command == 'getattr':
2047
attrname = request[1]
2048
if callable(client_object.__getattribute__(attrname)):
2049
parent_pipe.send(('function',))
2050
else:
2051
parent_pipe.send(('data', client_object
2052
.__getattribute__(attrname)))
2053
2054
if command == 'setattr':
2055
attrname = request[1]
2056
value = request[2]
2057
setattr(client_object, attrname, value)
2058
1243
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1244
self.handle_ipc)
1245
def handle_ipc(self, source, condition, file_objects={}):
1246
condition_names = {
1247
gobject.IO_IN: u"IN", # There is data to read.
1248
gobject.IO_OUT: u"OUT", # Data can be written (without
1249
# blocking).
1250
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1251
gobject.IO_ERR: u"ERR", # Error condition.
1252
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1253
# broken, usually for pipes and
1254
# sockets).
1255
}
1256
conditions_string = ' | '.join(name
1257
for cond, name in
1258
condition_names.iteritems()
1259
if cond & condition)
1260
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1261
conditions_string)
1262
1263
# Turn the pipe file descriptor into a Python file object
1264
if source not in file_objects:
1265
file_objects[source] = os.fdopen(source, u"r", 1)
1266
1267
# Read a line from the file object
1268
cmdline = file_objects[source].readline()
1269
if not cmdline: # Empty line means end of file
1270
# close the IPC pipe
1271
file_objects[source].close()
1272
del file_objects[source]
1273
1274
# Stop calling this function
1275
return False
1276
1277
logger.debug(u"IPC command: %r", cmdline)
1278
1279
# Parse and act on command
1280
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1281
1282
if cmd == u"NOTFOUND":
1283
fpr, address = args.split(None, 1)
1284
logger.warning(u"Client not found for fingerprint: %s, ad"
1285
u"dress: %s", fpr, address)
1286
if self.use_dbus:
1287
# Emit D-Bus signal
1288
mandos_dbus_service.ClientNotFound(fpr, address)
1289
elif cmd == u"INVALID":
1290
for client in self.clients:
1291
if client.name == args:
1292
logger.warning(u"Client %s is invalid", args)
1293
if self.use_dbus:
1294
# Emit D-Bus signal
1295
client.Rejected()
1296
break
1297
else:
1298
logger.error(u"Unknown client %s is invalid", args)
1299
elif cmd == u"SENDING":
1300
for client in self.clients:
1301
if client.name == args:
1302
logger.info(u"Sending secret to %s", client.name)
1303
client.checked_ok()
1304
if self.use_dbus:
1305
# Emit D-Bus signal
1306
client.GotSecret()
1307
break
1308
else:
1309
logger.error(u"Sending secret to unknown client %s",
1310
args)
1311
else:
1312
logger.error(u"Unknown IPC command: %r", cmdline)
1313
1314
# Keep calling this function
2059
1315
return True
2060
1316
2061
1317
2062
1318
def string_to_delta(interval):
2063
1319
"""Parse a string and return a datetime.timedelta
2064
1320
2065
>>> string_to_delta('7d')
1321
>>> string_to_delta(u'7d')
2066
1322
datetime.timedelta(7)
2067
>>> string_to_delta('60s')
1323
>>> string_to_delta(u'60s')
2068
1324
datetime.timedelta(0, 60)
2069
>>> string_to_delta('60m')
1325
>>> string_to_delta(u'60m')
2070
1326
datetime.timedelta(0, 3600)
2071
>>> string_to_delta('24h')
1327
>>> string_to_delta(u'24h')
2072
1328
datetime.timedelta(1)
2073
>>> string_to_delta('1w')
1329
>>> string_to_delta(u'1w')
2074
1330
datetime.timedelta(7)
2075
>>> string_to_delta('5m 30s')
1331
>>> string_to_delta(u'5m 30s')
2076
1332
datetime.timedelta(0, 330)
2077
1333
"""
2078
1334
timevalue = datetime.timedelta(0)
2080
1336
try:
2081
1337
suffix = unicode(s[-1])
2082
1338
value = int(s[:-1])
2083
if suffix == "d":
1339
if suffix == u"d":
2084
1340
delta = datetime.timedelta(value)
2085
elif suffix == "s":
1341
elif suffix == u"s":
2086
1342
delta = datetime.timedelta(0, value)
2087
elif suffix == "m":
1343
elif suffix == u"m":
2088
1344
delta = datetime.timedelta(0, 0, 0, 0, value)
2089
elif suffix == "h":
1345
elif suffix == u"h":
2090
1346
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2091
elif suffix == "w":
1347
elif suffix == u"w":
2092
1348
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2093
1349
else:
2094
raise ValueError("Unknown suffix {0!r}"
2095
.format(suffix))
2096
except (ValueError, IndexError) as e:
2097
raise ValueError(*(e.args))
1350
raise ValueError(u"Unknown suffix %r" % suffix)
1351
except (ValueError, IndexError), e:
1352
raise ValueError(e.message)
2098
1353
timevalue += delta
2099
1354
return timevalue
2100
1355
2101
1356
1357
def if_nametoindex(interface):
1358
"""Call the C function if_nametoindex(), or equivalent
1359
1360
Note: This function cannot accept a unicode string."""
1361
global if_nametoindex
1362
try:
1363
if_nametoindex = (ctypes.cdll.LoadLibrary
1364
(ctypes.util.find_library(u"c"))
1365
.if_nametoindex)
1366
except (OSError, AttributeError):
1367
logger.warning(u"Doing if_nametoindex the hard way")
1368
def if_nametoindex(interface):
1369
"Get an interface index the hard way, i.e. using fcntl()"
1370
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1371
with closing(socket.socket()) as s:
1372
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1373
struct.pack(str(u"16s16x"),
1374
interface))
1375
interface_index = struct.unpack(str(u"I"),
1376
ifreq[16:20])[0]
1377
return interface_index
1378
return if_nametoindex(interface)
1379
1380
2102
1381
def daemon(nochdir = False, noclose = False):
2103
1382
"""See daemon(3). Standard BSD Unix function.
2104
1383
2107
1386
sys.exit()
2108
1387
os.setsid()
2109
1388
if not nochdir:
2110
os.chdir("/")
1389
os.chdir(u"/")
2111
1390
if os.fork():
2112
1391
sys.exit()
2113
1392
if not noclose:
2114
1393
# Close all standard open file descriptors
2115
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1394
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2116
1395
if not stat.S_ISCHR(os.fstat(null).st_mode):
2117
1396
raise OSError(errno.ENODEV,
2118
"{0} not a character device"
2119
.format(os.devnull))
1397
u"%s not a character device"
1398
% os.path.devnull)
2120
1399
os.dup2(null, sys.stdin.fileno())
2121
1400
os.dup2(null, sys.stdout.fileno())
2122
1401
os.dup2(null, sys.stderr.fileno())
2129
1408
##################################################################
2130
1409
# Parsing of options, both command line and config file
2131
1410
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()
1411
parser = optparse.OptionParser(version = "%%prog %s" % version)
1412
parser.add_option("-i", u"--interface", type=u"string",
1413
metavar="IF", help=u"Bind to interface IF")
1414
parser.add_option("-a", u"--address", type=u"string",
1415
help=u"Address to listen for requests on")
1416
parser.add_option("-p", u"--port", type=u"int",
1417
help=u"Port number to receive requests on")
1418
parser.add_option("--check", action=u"store_true",
1419
help=u"Run self-test")
1420
parser.add_option("--debug", action=u"store_true",
1421
help=u"Debug mode; run in foreground and log to"
1422
u" terminal")
1423
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1424
u" priority string (see GnuTLS documentation)")
1425
parser.add_option("--servicename", type=u"string",
1426
metavar=u"NAME", help=u"Zeroconf service name")
1427
parser.add_option("--configdir", type=u"string",
1428
default=u"/etc/mandos", metavar=u"DIR",
1429
help=u"Directory to search for configuration"
1430
u" files")
1431
parser.add_option("--no-dbus", action=u"store_false",
1432
dest=u"use_dbus", help=u"Do not provide D-Bus"
1433
u" system bus interface")
1434
parser.add_option("--no-ipv6", action=u"store_false",
1435
dest=u"use_ipv6", help=u"Do not use IPv6")
1436
options = parser.parse_args()[0]
2169
1437
2170
1438
if options.check:
2171
1439
import doctest
2173
1441
sys.exit()
2174
1442
2175
1443
# 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"
1444
server_defaults = { u"interface": u"",
1445
u"address": u"",
1446
u"port": u"",
1447
u"debug": u"False",
1448
u"priority":
1449
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1450
u"servicename": u"Mandos",
1451
u"use_dbus": u"True",
1452
u"use_ipv6": u"True",
2188
1453
}
2189
1454
2190
1455
# Parse config file for server-global settings
2191
1456
server_config = configparser.SafeConfigParser(server_defaults)
2192
1457
del server_defaults
2193
1458
server_config.read(os.path.join(options.configdir,
2194
"mandos.conf"))
1459
u"mandos.conf"))
2195
1460
# Convert the SafeConfigParser object to a dict
2196
1461
server_settings = server_config.defaults()
2197
1462
# 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",
1463
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1464
server_settings[option] = server_config.getboolean(u"DEFAULT",
2200
1465
option)
2201
1466
if server_settings["port"]:
2202
server_settings["port"] = server_config.getint("DEFAULT",
2203
"port")
1467
server_settings["port"] = server_config.getint(u"DEFAULT",
1468
u"port")
2204
1469
del server_config
2205
1470
2206
1471
# Override the settings from the config file with command line
2207
1472
# options, if set.
2208
for option in ("interface", "address", "port", "debug",
2209
"priority", "servicename", "configdir",
2210
"use_dbus", "use_ipv6", "debuglevel", "restore",
2211
"statedir"):
1473
for option in (u"interface", u"address", u"port", u"debug",
1474
u"priority", u"servicename", u"configdir",
1475
u"use_dbus", u"use_ipv6"):
2212
1476
value = getattr(options, option)
2213
1477
if value is not None:
2214
1478
server_settings[option] = value
2222
1486
##################################################################
2223
1487
2224
1488
# 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":
1489
debug = server_settings[u"debug"]
1490
use_dbus = server_settings[u"use_dbus"]
1491
use_ipv6 = server_settings[u"use_ipv6"]
1492
1493
if not debug:
1494
syslogger.setLevel(logging.WARNING)
1495
console.setLevel(logging.WARNING)
1496
1497
if server_settings[u"servicename"] != u"Mandos":
2242
1498
syslogger.setFormatter(logging.Formatter
2243
('Mandos ({0}) [%(process)d]:'
2244
' %(levelname)s: %(message)s'
2245
.format(server_settings
2246
["servicename"])))
1499
(u'Mandos (%s) [%%(process)d]:'
1500
u' %%(levelname)s: %%(message)s'
1501
% server_settings[u"servicename"]))
2247
1502
2248
1503
# 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"))
1504
client_defaults = { u"timeout": u"1h",
1505
u"interval": u"5m",
1506
u"checker": u"fping -q -- %%(host)s",
1507
u"host": u"",
1508
}
1509
client_config = configparser.SafeConfigParser(client_defaults)
1510
client_config.read(os.path.join(server_settings[u"configdir"],
1511
u"clients.conf"))
2253
1512
2254
1513
global mandos_dbus_service
2255
1514
mandos_dbus_service = None
2256
1515
2257
tcp_server = MandosServer((server_settings["address"],
2258
server_settings["port"]),
1516
tcp_server = MandosServer((server_settings[u"address"],
1517
server_settings[u"port"]),
2259
1518
ClientHandler,
2260
interface=(server_settings["interface"]
2261
or None),
1519
interface=server_settings[u"interface"],
2262
1520
use_ipv6=use_ipv6,
2263
1521
gnutls_priority=
2264
server_settings["priority"],
1522
server_settings[u"priority"],
2265
1523
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)
1524
pidfilename = u"/var/run/mandos.pid"
1525
try:
1526
pidfile = open(pidfilename, u"w")
1527
except IOError:
1528
logger.error(u"Could not open file %r", pidfilename)
2273
1529
2274
for name in ("_mandos", "mandos", "nobody"):
1530
try:
1531
uid = pwd.getpwnam(u"_mandos").pw_uid
1532
gid = pwd.getpwnam(u"_mandos").pw_gid
1533
except KeyError:
2275
1534
try:
2276
uid = pwd.getpwnam(name).pw_uid
2277
gid = pwd.getpwnam(name).pw_gid
2278
break
1535
uid = pwd.getpwnam(u"mandos").pw_uid
1536
gid = pwd.getpwnam(u"mandos").pw_gid
2279
1537
except KeyError:
2280
continue
2281
else:
2282
uid = 65534
2283
gid = 65534
1538
try:
1539
uid = pwd.getpwnam(u"nobody").pw_uid
1540
gid = pwd.getpwnam(u"nobody").pw_gid
1541
except KeyError:
1542
uid = 65534
1543
gid = 65534
2284
1544
try:
2285
1545
os.setgid(gid)
2286
1546
os.setuid(uid)
2287
except OSError as error:
1547
except OSError, error:
2288
1548
if error[0] != errno.EPERM:
2289
1549
raise error
2290
1550
1551
# Enable all possible GnuTLS debugging
2291
1552
if debug:
2292
# Enable all possible GnuTLS debugging
2293
2294
1553
# "Use a log level over 10 to enable all debugging options."
2295
1554
# - GnuTLS manual
2296
1555
gnutls.library.functions.gnutls_global_set_log_level(11)
2297
1556
2298
1557
@gnutls.library.types.gnutls_log_func
2299
1558
def debug_gnutls(level, string):
2300
logger.debug("GnuTLS: %s", string[:-1])
1559
logger.debug(u"GnuTLS: %s", string[:-1])
2301
1560
2302
1561
(gnutls.library.functions
2303
1562
.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
1563
2318
1564
global main_loop
2319
1565
# From the Avahi example code
2320
DBusGMainLoop(set_as_default=True)
1566
DBusGMainLoop(set_as_default=True )
2321
1567
main_loop = gobject.MainLoop()
2322
1568
bus = dbus.SystemBus()
2323
1569
# End of Avahi example code
2324
1570
if use_dbus:
2325
1571
try:
2326
bus_name = dbus.service.BusName("se.recompile.Mandos",
1572
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2327
1573
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)
1574
except dbus.exceptions.NameExistsException, e:
1575
logger.error(unicode(e) + u", disabling D-Bus")
2333
1576
use_dbus = False
2334
server_settings["use_dbus"] = False
1577
server_settings[u"use_dbus"] = False
2335
1578
tcp_server.use_dbus = False
2336
1579
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)
1580
service = AvahiService(name = server_settings[u"servicename"],
1581
servicetype = u"_mandos._tcp",
1582
protocol = protocol, bus = bus)
2341
1583
if server_settings["interface"]:
2342
1584
service.interface = (if_nametoindex
2343
(str(server_settings["interface"])))
2344
2345
global multiprocessing_manager
2346
multiprocessing_manager = multiprocessing.Manager()
1585
(str(server_settings[u"interface"])))
2347
1586
2348
1587
client_class = Client
2349
1588
if use_dbus:
2350
1589
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))
2421
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
1590
tcp_server.clients.update(set(
1591
client_class(name = section,
1592
config= dict(client_config.items(section)))
1593
for section in client_config.sections()))
2446
1594
if not tcp_server.clients:
2447
logger.warning("No clients defined")
1595
logger.warning(u"No clients defined")
1596
1597
if debug:
1598
# Redirect stdin so all checkers get /dev/null
1599
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1600
os.dup2(null, sys.stdin.fileno())
1601
if null > 2:
1602
os.close(null)
1603
else:
1604
# No console logging
1605
logger.removeHandler(console)
1606
# Close all input and output, do double fork, etc.
1607
daemon()
1608
1609
try:
1610
with closing(pidfile):
1611
pid = os.getpid()
1612
pidfile.write(str(pid) + "\n")
1613
del pidfile
1614
except IOError:
1615
logger.error(u"Could not write to file %r with PID %d",
1616
pidfilename, pid)
1617
except NameError:
1618
# "pidfile" was never created
1619
pass
1620
del pidfilename
2448
1621
2449
1622
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
1623
signal.signal(signal.SIGINT, signal.SIG_IGN)
2463
2464
1624
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2465
1625
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2466
1626
2467
1627
if use_dbus:
2468
@alternate_dbus_interfaces({"se.recompile.Mandos":
2469
"se.bsnet.fukt.Mandos"})
2470
class MandosDBusService(DBusObjectWithProperties):
1628
class MandosDBusService(dbus.service.Object):
2471
1629
"""A D-Bus proxy object"""
2472
1630
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")
2483
def ClientAdded(self, objpath):
1631
dbus.service.Object.__init__(self, bus, u"/")
1632
_interface = u"se.bsnet.fukt.Mandos"
1633
1634
@dbus.service.signal(_interface, signature=u"oa{sv}")
1635
def ClientAdded(self, objpath, properties):
2484
1636
"D-Bus signal"
2485
1637
pass
2486
1638
2487
@dbus.service.signal(_interface, signature="ss")
1639
@dbus.service.signal(_interface, signature=u"ss")
2488
1640
def ClientNotFound(self, fingerprint, address):
2489
1641
"D-Bus signal"
2490
1642
pass
2491
1643
2492
@dbus.service.signal(_interface, signature="os")
1644
@dbus.service.signal(_interface, signature=u"os")
2493
1645
def ClientRemoved(self, objpath, name):
2494
1646
"D-Bus signal"
2495
1647
pass
2496
1648
2497
@dbus.service.method(_interface, out_signature="ao")
1649
@dbus.service.method(_interface, out_signature=u"ao")
2498
1650
def GetAllClients(self):
2499
1651
"D-Bus method"
2500
1652
return dbus.Array(c.dbus_object_path
2501
for c in
2502
tcp_server.clients.itervalues())
1653
for c in tcp_server.clients)
2503
1654
2504
1655
@dbus.service.method(_interface,
2505
out_signature="a{oa{sv}}")
1656
out_signature=u"a{oa{sv}}")
2506
1657
def GetAllClientsWithProperties(self):
2507
1658
"D-Bus method"
2508
1659
return dbus.Dictionary(
2509
((c.dbus_object_path, c.GetAll(""))
2510
for c in tcp_server.clients.itervalues()),
2511
signature="oa{sv}")
1660
((c.dbus_object_path, c.GetAll(u""))
1661
for c in tcp_server.clients),
1662
signature=u"oa{sv}")
2512
1663
2513
@dbus.service.method(_interface, in_signature="o")
1664
@dbus.service.method(_interface, in_signature=u"o")
2514
1665
def RemoveClient(self, object_path):
2515
1666
"D-Bus method"
2516
for c in tcp_server.clients.itervalues():
1667
for c in tcp_server.clients:
2517
1668
if c.dbus_object_path == object_path:
2518
del tcp_server.clients[c.name]
1669
tcp_server.clients.remove(c)
2519
1670
c.remove_from_connection()
2520
1671
# Don't signal anything except ClientRemoved
2521
1672
c.disable(quiet=True)
2532
1683
"Cleanup function; run on exit"
2533
1684
service.cleanup()
2534
1685
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
1686
while tcp_server.clients:
2591
name, client = tcp_server.clients.popitem()
1687
client = tcp_server.clients.pop()
2592
1688
if use_dbus:
2593
1689
client.remove_from_connection()
1690
client.disable_hook = None
2594
1691
# Don't signal anything except ClientRemoved
2595
1692
client.disable(quiet=True)
2596
1693
if use_dbus:
2597
1694
# Emit D-Bus signal
2598
mandos_dbus_service.ClientRemoved(client
2599
.dbus_object_path,
1695
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2600
1696
client.name)
2601
client_settings.clear()
2602
1697
2603
1698
atexit.register(cleanup)
2604
1699
2605
for client in tcp_server.clients.itervalues():
1700
for client in tcp_server.clients:
2606
1701
if use_dbus:
2607
1702
# Emit D-Bus signal
2608
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2609
# Need to initiate checking of clients
2610
if client.enabled:
2611
client.init_checker()
1703
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1704
client.GetAll(u""))
1705
client.enable()
2612
1706
2613
1707
tcp_server.enable()
2614
1708
tcp_server.server_activate()
2616
1710
# Find out what port we got
2617
1711
service.port = tcp_server.socket.getsockname()[1]
2618
1712
if use_ipv6:
2619
logger.info("Now listening on address %r, port %d,"
2620
" flowinfo %d, scope_id %d",
2621
*tcp_server.socket.getsockname())
1713
logger.info(u"Now listening on address %r, port %d,"
1714
" flowinfo %d, scope_id %d"
1715
% tcp_server.socket.getsockname())
2622
1716
else: # IPv4
2623
logger.info("Now listening on address %r, port %d",
2624
*tcp_server.socket.getsockname())
1717
logger.info(u"Now listening on address %r, port %d"
1718
% tcp_server.socket.getsockname())
2625
1719
2626
1720
#service.interface = tcp_server.socket.getsockname()[3]
2627
1721
2629
1723
# From the Avahi example code
2630
1724
try:
2631
1725
service.activate()
2632
except dbus.exceptions.DBusException as error:
2633
logger.critical("D-Bus Exception", exc_info=error)
1726
except dbus.exceptions.DBusException, error:
1727
logger.critical(u"DBusException: %s", error)
2634
1728
cleanup()
2635
1729
sys.exit(1)
2636
1730
# End of Avahi example code
2640
1734
(tcp_server.handle_request
2641
1735
(*args[2:], **kwargs) or True))
2642
1736
2643
logger.debug("Starting main loop")
1737
logger.debug(u"Starting main loop")
2644
1738
main_loop.run()
2645
except AvahiError as error:
2646
logger.critical("Avahi Error", exc_info=error)
1739
except AvahiError, error:
1740
logger.critical(u"AvahiError: %s", error)
2647
1741
cleanup()
2648
1742
sys.exit(1)
2649
1743
except KeyboardInterrupt:
2650
1744
if debug:
2651
print("", file=sys.stderr)
2652
logger.debug("Server received KeyboardInterrupt")
2653
logger.debug("Server exiting")
1745
print >> sys.stderr
1746
logger.debug(u"Server received KeyboardInterrupt")
1747
logger.debug(u"Server exiting")
2654
1748
# Must run before the D-Bus bus name gets deregistered
2655
1749
cleanup()
2656
1750
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0