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