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