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