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