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