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