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