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