To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 286
- compare with another revision
- download diff
- download tarball
- view history from revision 286
- Committer: Teddy Hogeborn
- Date: 2011-10-09 16:38:18 UTC
- mfrom: (237.7.61 trunk)
- Revision ID: teddy@recompile.se-20111009163818-ihb35bqq0iat18k2
Merge from trunk.
- 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.disable_initiator_tag = (gobject.timeout_add
469
(_timedelta_to_milliseconds
470
(timeout), self.disable))
471
self.expires = datetime.datetime.utcnow() + timeout
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.
702
502
self.current_checker_command)
703
503
# Start a new checker if needed
704
504
if self.checker is None:
705
# Escape attributes for the shell
706
escaped_attrs = dict(
707
(attr, re.escape(unicode(getattr(self, attr))))
708
for attr in
709
self.runtime_expansions)
710
505
try:
711
command = self.checker_command % escaped_attrs
712
except TypeError as error:
713
logger.error('Could not format string "%s"',
714
self.checker_command, exc_info=error)
715
return True # Try again later
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
716
524
self.current_checker_command = command
717
525
try:
718
526
logger.info("Starting checker %r for %s",
721
529
# in normal mode, that is already done by daemon(),
722
530
# and in debug mode we don't want to. (Stdin is
723
531
# always replaced by /dev/null.)
724
# The exception is when not debugging but nevertheless
725
# running in the foreground; use the previously
726
# created wnull.
727
popen_args = {}
728
if (not self.server_settings["debug"]
729
and self.server_settings["foreground"]):
730
popen_args.update({"stdout": wnull,
731
"stderr": wnull })
732
532
self.checker = subprocess.Popen(command,
733
533
close_fds=True,
734
shell=True, cwd="/",
735
**popen_args)
736
except OSError as error:
737
logger.error("Failed to start subprocess",
738
exc_info=error)
739
return True
740
self.checker_callback_tag = (gobject.child_watch_add
741
(self.checker.pid,
742
self.checker_callback,
743
data=command))
744
# The checker may have completed before the gobject
745
# watch was added. Check for this.
746
try:
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.
747
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)
748
545
except OSError as error:
749
if error.errno == errno.ECHILD:
750
# This should never happen
751
logger.error("Child process vanished",
752
exc_info=error)
753
return True
754
raise
755
if pid:
756
gobject.source_remove(self.checker_callback_tag)
757
self.checker_callback(pid, status, command)
546
logger.error("Failed to start subprocess: %s",
547
error)
758
548
# Re-run this periodically if run by gobject.timeout_add
759
549
return True
760
550
767
557
return
768
558
logger.debug("Stopping checker for %(name)s", vars(self))
769
559
try:
770
self.checker.terminate()
560
os.kill(self.checker.pid, signal.SIGTERM)
771
561
#time.sleep(0.5)
772
562
#if self.checker.poll() is None:
773
# self.checker.kill()
563
# os.kill(self.checker.pid, signal.SIGKILL)
774
564
except OSError as error:
775
565
if error.errno != errno.ESRCH: # No such process
776
566
raise
793
583
# "Set" method, so we fail early here:
794
584
if byte_arrays and signature != "ay":
795
585
raise ValueError("Byte arrays not supported for non-'ay'"
796
" signature {0!r}".format(signature))
586
" signature %r" % signature)
797
587
def decorator(func):
798
588
func._dbus_is_property = True
799
589
func._dbus_interface = dbus_interface
807
597
return decorator
808
598
809
599
810
def dbus_interface_annotations(dbus_interface):
811
"""Decorator for marking functions returning interface annotations
812
813
Usage:
814
815
@dbus_interface_annotations("org.example.Interface")
816
def _foo(self): # Function name does not matter
817
return {"org.freedesktop.DBus.Deprecated": "true",
818
"org.freedesktop.DBus.Property.EmitsChangedSignal":
819
"false"}
820
"""
821
def decorator(func):
822
func._dbus_is_interface = True
823
func._dbus_interface = dbus_interface
824
func._dbus_name = dbus_interface
825
return func
826
return decorator
827
828
829
def dbus_annotations(annotations):
830
"""Decorator to annotate D-Bus methods, signals or properties
831
Usage:
832
833
@dbus_service_property("org.example.Interface", signature="b",
834
access="r")
835
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
836
"org.freedesktop.DBus.Property."
837
"EmitsChangedSignal": "false"})
838
def Property_dbus_property(self):
839
return dbus.Boolean(False)
840
"""
841
def decorator(func):
842
func._dbus_annotations = annotations
843
return func
844
return decorator
845
846
847
600
class DBusPropertyException(dbus.exceptions.DBusException):
848
601
"""A base class for D-Bus property-related exceptions
849
602
"""
872
625
"""
873
626
874
627
@staticmethod
875
def _is_dbus_thing(thing):
876
"""Returns a function testing if an attribute is a D-Bus thing
877
878
If called like _is_dbus_thing("method") it returns a function
879
suitable for use as predicate to inspect.getmembers().
880
"""
881
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
882
False)
628
def _is_dbus_property(obj):
629
return getattr(obj, "_dbus_is_property", False)
883
630
884
def _get_all_dbus_things(self, thing):
631
def _get_all_dbus_properties(self):
885
632
"""Returns a generator of (name, attribute) pairs
886
633
"""
887
return ((getattr(athing.__get__(self), "_dbus_name",
888
name),
889
athing.__get__(self))
634
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
890
635
for cls in self.__class__.__mro__
891
for name, athing in
892
inspect.getmembers(cls,
893
self._is_dbus_thing(thing)))
636
for name, prop in
637
inspect.getmembers(cls, self._is_dbus_property))
894
638
895
639
def _get_dbus_property(self, interface_name, property_name):
896
640
"""Returns a bound method if one exists which is a D-Bus
898
642
"""
899
643
for cls in self.__class__.__mro__:
900
644
for name, value in (inspect.getmembers
901
(cls,
902
self._is_dbus_thing("property"))):
645
(cls, self._is_dbus_property)):
903
646
if (value._dbus_name == property_name
904
647
and value._dbus_interface == interface_name):
905
648
return value.__get__(self)
934
677
# signatures other than "ay".
935
678
if prop._dbus_signature != "ay":
936
679
raise ValueError
937
value = dbus.ByteArray(b''.join(chr(byte)
938
for byte in value))
680
value = dbus.ByteArray(''.join(unichr(byte)
681
for byte in value))
939
682
prop(value)
940
683
941
684
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
946
689
947
690
Note: Will not include properties with access="write".
948
691
"""
949
properties = {}
950
for name, prop in self._get_all_dbus_things("property"):
692
all = {}
693
for name, prop in self._get_all_dbus_properties():
951
694
if (interface_name
952
695
and interface_name != prop._dbus_interface):
953
696
# Interface non-empty but did not match
957
700
continue
958
701
value = prop()
959
702
if not hasattr(value, "variant_level"):
960
properties[name] = value
703
all[name] = value
961
704
continue
962
properties[name] = type(value)(value, variant_level=
963
value.variant_level+1)
964
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")
965
708
966
709
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
967
710
out_signature="s",
968
711
path_keyword='object_path',
969
712
connection_keyword='connection')
970
713
def Introspect(self, object_path, connection):
971
"""Overloading of standard D-Bus method.
972
973
Inserts property tags and interface annotation tags.
714
"""Standard D-Bus method, overloaded to insert property tags.
974
715
"""
975
716
xmlstring = dbus.service.Object.Introspect(self, object_path,
976
717
connection)
983
724
e.setAttribute("access", prop._dbus_access)
984
725
return e
985
726
for if_tag in document.getElementsByTagName("interface"):
986
# Add property tags
987
727
for tag in (make_tag(document, name, prop)
988
728
for name, prop
989
in self._get_all_dbus_things("property")
729
in self._get_all_dbus_properties()
990
730
if prop._dbus_interface
991
731
== if_tag.getAttribute("name")):
992
732
if_tag.appendChild(tag)
993
# Add annotation tags
994
for typ in ("method", "signal", "property"):
995
for tag in if_tag.getElementsByTagName(typ):
996
annots = dict()
997
for name, prop in (self.
998
_get_all_dbus_things(typ)):
999
if (name == tag.getAttribute("name")
1000
and prop._dbus_interface
1001
== if_tag.getAttribute("name")):
1002
annots.update(getattr
1003
(prop,
1004
"_dbus_annotations",
1005
{}))
1006
for name, value in annots.iteritems():
1007
ann_tag = document.createElement(
1008
"annotation")
1009
ann_tag.setAttribute("name", name)
1010
ann_tag.setAttribute("value", value)
1011
tag.appendChild(ann_tag)
1012
# Add interface annotation tags
1013
for annotation, value in dict(
1014
itertools.chain.from_iterable(
1015
annotations().iteritems()
1016
for name, annotations in
1017
self._get_all_dbus_things("interface")
1018
if name == if_tag.getAttribute("name")
1019
)).iteritems():
1020
ann_tag = document.createElement("annotation")
1021
ann_tag.setAttribute("name", annotation)
1022
ann_tag.setAttribute("value", value)
1023
if_tag.appendChild(ann_tag)
1024
733
# Add the names to the return values for the
1025
734
# "org.freedesktop.DBus.Properties" methods
1026
735
if (if_tag.getAttribute("name")
1041
750
except (AttributeError, xml.dom.DOMException,
1042
751
xml.parsers.expat.ExpatError) as error:
1043
752
logger.error("Failed to override Introspection method",
1044
exc_info=error)
753
error)
1045
754
return xmlstring
1046
755
1047
756
1048
def datetime_to_dbus(dt, variant_level=0):
757
def datetime_to_dbus (dt, variant_level=0):
1049
758
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1050
759
if dt is None:
1051
760
return dbus.String("", variant_level = variant_level)
1052
761
return dbus.String(dt.isoformat(),
1053
762
variant_level=variant_level)
1054
763
1055
1056
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1057
"""A class decorator; applied to a subclass of
1058
dbus.service.Object, it will add alternate D-Bus attributes with
1059
interface names according to the "alt_interface_names" mapping.
1060
Usage:
1061
1062
@alternate_dbus_interfaces({"org.example.Interface":
1063
"net.example.AlternateInterface"})
1064
class SampleDBusObject(dbus.service.Object):
1065
@dbus.service.method("org.example.Interface")
1066
def SampleDBusMethod():
1067
pass
1068
1069
The above "SampleDBusMethod" on "SampleDBusObject" will be
1070
reachable via two interfaces: "org.example.Interface" and
1071
"net.example.AlternateInterface", the latter of which will have
1072
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1073
"true", unless "deprecate" is passed with a False value.
1074
1075
This works for methods and signals, and also for D-Bus properties
1076
(from DBusObjectWithProperties) and interfaces (from the
1077
dbus_interface_annotations decorator).
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.
1078
768
"""
1079
def wrapper(cls):
1080
for orig_interface_name, alt_interface_name in (
1081
alt_interface_names.iteritems()):
1082
attr = {}
1083
interface_names = set()
1084
# Go though all attributes of the class
1085
for attrname, attribute in inspect.getmembers(cls):
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):
1086
776
# Ignore non-D-Bus attributes, and D-Bus attributes
1087
777
# with the wrong interface name
1088
778
if (not hasattr(attribute, "_dbus_interface")
1089
779
or not attribute._dbus_interface
1090
.startswith(orig_interface_name)):
780
.startswith("se.recompile.Mandos")):
1091
781
continue
1092
782
# Create an alternate D-Bus interface name based on
1093
783
# the current name
1094
784
alt_interface = (attribute._dbus_interface
1095
.replace(orig_interface_name,
1096
alt_interface_name))
1097
interface_names.add(alt_interface)
785
.replace("se.recompile.Mandos",
786
"se.bsnet.fukt.Mandos"))
1098
787
# Is this a D-Bus signal?
1099
788
if getattr(attribute, "_dbus_is_signal", False):
1100
# Extract the original non-method undecorated
1101
# function by black magic
789
# Extract the original non-method function by
790
# black magic
1102
791
nonmethod_func = (dict(
1103
792
zip(attribute.func_code.co_freevars,
1104
793
attribute.__closure__))["func"]
1115
804
nonmethod_func.func_name,
1116
805
nonmethod_func.func_defaults,
1117
806
nonmethod_func.func_closure)))
1118
# Copy annotations, if any
1119
try:
1120
new_function._dbus_annotations = (
1121
dict(attribute._dbus_annotations))
1122
except AttributeError:
1123
pass
1124
807
# Define a creator of a function to call both the
1125
# original and alternate functions, so both the
1126
# original and alternate signals gets sent when
1127
# the function is called
808
# old and new functions, so both the old and new
809
# signals gets sent when the function is called
1128
810
def fixscope(func1, func2):
1129
811
"""This function is a scope container to pass
1130
812
func1 and func2 to the "call_both" function
1137
819
return call_both
1138
820
# Create the "call_both" function and add it to
1139
821
# the class
1140
attr[attrname] = fixscope(attribute, new_function)
822
attr[attrname] = fixscope(attribute,
823
new_function)
1141
824
# Is this a D-Bus method?
1142
825
elif getattr(attribute, "_dbus_is_method", False):
1143
826
# Create a new, but exactly alike, function
1154
837
attribute.func_name,
1155
838
attribute.func_defaults,
1156
839
attribute.func_closure)))
1157
# Copy annotations, if any
1158
try:
1159
attr[attrname]._dbus_annotations = (
1160
dict(attribute._dbus_annotations))
1161
except AttributeError:
1162
pass
1163
840
# Is this a D-Bus property?
1164
841
elif getattr(attribute, "_dbus_is_property", False):
1165
842
# Create a new, but exactly alike, function
1179
856
attribute.func_name,
1180
857
attribute.func_defaults,
1181
858
attribute.func_closure)))
1182
# Copy annotations, if any
1183
try:
1184
attr[attrname]._dbus_annotations = (
1185
dict(attribute._dbus_annotations))
1186
except AttributeError:
1187
pass
1188
# Is this a D-Bus interface?
1189
elif getattr(attribute, "_dbus_is_interface", False):
1190
# Create a new, but exactly alike, function
1191
# object. Decorate it to be a new D-Bus interface
1192
# with the alternate D-Bus interface name. Add it
1193
# to the class.
1194
attr[attrname] = (dbus_interface_annotations
1195
(alt_interface)
1196
(types.FunctionType
1197
(attribute.func_code,
1198
attribute.func_globals,
1199
attribute.func_name,
1200
attribute.func_defaults,
1201
attribute.func_closure)))
1202
if deprecate:
1203
# Deprecate all alternate interfaces
1204
iname="_AlternateDBusNames_interface_annotation{0}"
1205
for interface_name in interface_names:
1206
@dbus_interface_annotations(interface_name)
1207
def func(self):
1208
return { "org.freedesktop.DBus.Deprecated":
1209
"true" }
1210
# Find an unused name
1211
for aname in (iname.format(i)
1212
for i in itertools.count()):
1213
if aname not in attr:
1214
attr[aname] = func
1215
break
1216
if interface_names:
1217
# Replace the class with a new subclass of it with
1218
# methods, signals, etc. as created above.
1219
cls = type(b"{0}Alternate".format(cls.__name__),
1220
(cls,), attr)
1221
return cls
1222
return wrapper
1223
1224
1225
@alternate_dbus_interfaces({"se.recompile.Mandos":
1226
"se.bsnet.fukt.Mandos"})
859
return type.__new__(mcs, name, bases, attr)
860
1227
861
class ClientDBus(Client, DBusObjectWithProperties):
1228
862
"""A Client class using D-Bus
1229
863
1238
872
# dbus.service.Object doesn't use super(), so we can't either.
1239
873
1240
874
def __init__(self, bus = None, *args, **kwargs):
875
self._approvals_pending = 0
1241
876
self.bus = bus
1242
877
Client.__init__(self, *args, **kwargs)
1243
878
# Only now, when this client is initialized, can it show up on
1249
884
("/clients/" + client_object_name))
1250
885
DBusObjectWithProperties.__init__(self, self.bus,
1251
886
self.dbus_object_path)
1252
887
1253
888
def notifychangeproperty(transform_func,
1254
889
dbus_name, type_func=lambda x: x,
1255
890
variant_level=1):
1256
891
""" Modify a variable so that it's a property which announces
1257
892
its changes to DBus.
1258
1259
transform_fun: Function that takes a value and a variant_level
1260
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.
1261
896
dbus_name: D-Bus name of the variable
1262
897
type_func: Function that transform the value before sending it
1263
898
to the D-Bus. Default: no transform
1270
905
type_func(getattr(self, attrname, None))
1271
906
!= type_func(value)):
1272
907
dbus_value = transform_func(type_func(value),
1273
variant_level
1274
=variant_level)
908
variant_level)
1275
909
self.PropertyChanged(dbus.String(dbus_name),
1276
910
dbus_value)
1277
911
setattr(self, attrname, value)
1278
912
1279
913
return property(lambda self: getattr(self, attrname), setter)
1280
914
915
1281
916
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1282
917
approvals_pending = notifychangeproperty(dbus.Boolean,
1283
918
"ApprovalPending",
1290
925
checker is not None)
1291
926
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1292
927
"LastCheckedOK")
1293
last_checker_status = notifychangeproperty(dbus.Int16,
1294
"LastCheckerStatus")
1295
928
last_approval_request = notifychangeproperty(
1296
929
datetime_to_dbus, "LastApprovalRequest")
1297
930
approved_by_default = notifychangeproperty(dbus.Boolean,
1298
931
"ApprovedByDefault")
1299
approval_delay = notifychangeproperty(dbus.UInt64,
932
approval_delay = notifychangeproperty(dbus.UInt16,
1300
933
"ApprovalDelay",
1301
934
type_func =
1302
timedelta_to_milliseconds)
935
_timedelta_to_milliseconds)
1303
936
approval_duration = notifychangeproperty(
1304
dbus.UInt64, "ApprovalDuration",
1305
type_func = timedelta_to_milliseconds)
937
dbus.UInt16, "ApprovalDuration",
938
type_func = _timedelta_to_milliseconds)
1306
939
host = notifychangeproperty(dbus.String, "Host")
1307
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
940
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1308
941
type_func =
1309
timedelta_to_milliseconds)
942
_timedelta_to_milliseconds)
1310
943
extended_timeout = notifychangeproperty(
1311
dbus.UInt64, "ExtendedTimeout",
1312
type_func = timedelta_to_milliseconds)
1313
interval = notifychangeproperty(dbus.UInt64,
944
dbus.UInt16, "ExtendedTimeout",
945
type_func = _timedelta_to_milliseconds)
946
interval = notifychangeproperty(dbus.UInt16,
1314
947
"Interval",
1315
948
type_func =
1316
timedelta_to_milliseconds)
949
_timedelta_to_milliseconds)
1317
950
checker_command = notifychangeproperty(dbus.String, "Checker")
1318
951
1319
952
del notifychangeproperty
1361
994
return r
1362
995
1363
996
def _reset_approved(self):
1364
self.approved = None
997
self._approved = None
1365
998
return False
1366
999
1367
1000
def approve(self, value=True):
1368
self.approved = value
1369
gobject.timeout_add(timedelta_to_milliseconds
1001
self.send_changedstate()
1002
self._approved = value
1003
gobject.timeout_add(_timedelta_to_milliseconds
1370
1004
(self.approval_duration),
1371
1005
self._reset_approved)
1372
self.send_changedstate()
1006
1373
1007
1374
1008
## D-Bus methods, signals & properties
1375
1009
_interface = "se.recompile.Mandos.Client"
1376
1010
1377
## Interfaces
1378
1379
@dbus_interface_annotations(_interface)
1380
def _foo(self):
1381
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1382
"false"}
1383
1384
1011
## Signals
1385
1012
1386
1013
# CheckerCompleted - signal
1485
1112
access="readwrite")
1486
1113
def ApprovalDuration_dbus_property(self, value=None):
1487
1114
if value is None: # get
1488
return dbus.UInt64(timedelta_to_milliseconds(
1115
return dbus.UInt64(_timedelta_to_milliseconds(
1489
1116
self.approval_duration))
1490
1117
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1491
1118
1505
1132
def Host_dbus_property(self, value=None):
1506
1133
if value is None: # get
1507
1134
return dbus.String(self.host)
1508
self.host = unicode(value)
1135
self.host = value
1509
1136
1510
1137
# Created - property
1511
1138
@dbus_service_property(_interface, signature="s", access="read")
1512
1139
def Created_dbus_property(self):
1513
return datetime_to_dbus(self.created)
1140
return dbus.String(datetime_to_dbus(self.created))
1514
1141
1515
1142
# LastEnabled - property
1516
1143
@dbus_service_property(_interface, signature="s", access="read")
1537
1164
return
1538
1165
return datetime_to_dbus(self.last_checked_ok)
1539
1166
1540
# LastCheckerStatus - property
1541
@dbus_service_property(_interface, signature="n",
1542
access="read")
1543
def LastCheckerStatus_dbus_property(self):
1544
return dbus.Int16(self.last_checker_status)
1545
1546
1167
# Expires - property
1547
1168
@dbus_service_property(_interface, signature="s", access="read")
1548
1169
def Expires_dbus_property(self):
1559
1180
def Timeout_dbus_property(self, value=None):
1560
1181
if value is None: # get
1561
1182
return dbus.UInt64(self.timeout_milliseconds())
1562
old_timeout = self.timeout
1563
1183
self.timeout = datetime.timedelta(0, 0, 0, value)
1564
# Reschedule disabling
1565
if self.enabled:
1566
now = datetime.datetime.utcnow()
1567
self.expires += self.timeout - old_timeout
1568
if self.expires <= now:
1569
# The timeout has passed
1570
self.disable()
1571
else:
1572
if (getattr(self, "disable_initiator_tag", None)
1573
is None):
1574
return
1575
gobject.source_remove(self.disable_initiator_tag)
1576
self.disable_initiator_tag = (
1577
gobject.timeout_add(
1578
timedelta_to_milliseconds(self.expires - now),
1579
self.disable))
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))
1580
1205
1581
1206
# ExtendedTimeout - property
1582
1207
@dbus_service_property(_interface, signature="t",
1595
1220
self.interval = datetime.timedelta(0, 0, 0, value)
1596
1221
if getattr(self, "checker_initiator_tag", None) is None:
1597
1222
return
1598
if self.enabled:
1599
# Reschedule checker run
1600
gobject.source_remove(self.checker_initiator_tag)
1601
self.checker_initiator_tag = (gobject.timeout_add
1602
(value, self.start_checker))
1603
self.start_checker() # Start one now, too
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
1604
1228
1605
1229
# Checker - property
1606
1230
@dbus_service_property(_interface, signature="s",
1608
1232
def Checker_dbus_property(self, value=None):
1609
1233
if value is None: # get
1610
1234
return dbus.String(self.checker_command)
1611
self.checker_command = unicode(value)
1235
self.checker_command = value
1612
1236
1613
1237
# CheckerRunning - property
1614
1238
@dbus_service_property(_interface, signature="b",
1643
1267
raise KeyError()
1644
1268
1645
1269
def __getattribute__(self, name):
1646
if name == '_pipe':
1270
if(name == '_pipe'):
1647
1271
return super(ProxyClient, self).__getattribute__(name)
1648
1272
self._pipe.send(('getattr', name))
1649
1273
data = self._pipe.recv()
1656
1280
return func
1657
1281
1658
1282
def __setattr__(self, name, value):
1659
if name == '_pipe':
1283
if(name == '_pipe'):
1660
1284
return super(ProxyClient, self).__setattr__(name, value)
1661
1285
self._pipe.send(('setattr', name, value))
1662
1286
1287
class ClientDBusTransitional(ClientDBus):
1288
__metaclass__ = AlternateDBusNamesMetaclass
1663
1289
1664
1290
class ClientHandler(socketserver.BaseRequestHandler, object):
1665
1291
"""A class to handle client connections.
1748
1374
client.Rejected("Disabled")
1749
1375
return
1750
1376
1751
if client.approved or not client.approval_delay:
1377
if client._approved or not client.approval_delay:
1752
1378
#We are approved or approval is disabled
1753
1379
break
1754
elif client.approved is None:
1380
elif client._approved is None:
1755
1381
logger.info("Client %s needs approval",
1756
1382
client.name)
1757
1383
if self.server.use_dbus:
1770
1396
#wait until timeout or approved
1771
1397
time = datetime.datetime.now()
1772
1398
client.changedstate.acquire()
1773
client.changedstate.wait(
1774
float(timedelta_to_milliseconds(delay)
1775
/ 1000))
1399
(client.changedstate.wait
1400
(float(client._timedelta_to_milliseconds(delay)
1401
/ 1000)))
1776
1402
client.changedstate.release()
1777
1403
time2 = datetime.datetime.now()
1778
1404
if (time2 - time) >= delay:
1794
1420
try:
1795
1421
sent = session.send(client.secret[sent_size:])
1796
1422
except gnutls.errors.GNUTLSError as error:
1797
logger.warning("gnutls send failed",
1798
exc_info=error)
1423
logger.warning("gnutls send failed")
1799
1424
return
1800
1425
logger.debug("Sent: %d, remaining: %d",
1801
1426
sent, len(client.secret)
1803
1428
sent_size += sent
1804
1429
1805
1430
logger.info("Sending secret to %s", client.name)
1806
# bump the timeout using extended_timeout
1807
client.bump_timeout(client.extended_timeout)
1431
# bump the timeout as if seen
1432
client.checked_ok(client.extended_timeout)
1808
1433
if self.server.use_dbus:
1809
1434
# Emit D-Bus signal
1810
1435
client.GotSecret()
1815
1440
try:
1816
1441
session.bye()
1817
1442
except gnutls.errors.GNUTLSError as error:
1818
logger.warning("GnuTLS bye failed",
1819
exc_info=error)
1443
logger.warning("GnuTLS bye failed")
1820
1444
1821
1445
@staticmethod
1822
1446
def peer_certificate(session):
1878
1502
# Convert the buffer to a Python bytestring
1879
1503
fpr = ctypes.string_at(buf, buf_len.value)
1880
1504
# Convert the bytestring to hexadecimal notation
1881
hex_fpr = binascii.hexlify(fpr).upper()
1505
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1882
1506
return hex_fpr
1883
1507
1884
1508
1887
1511
def sub_process_main(self, request, address):
1888
1512
try:
1889
1513
self.finish_request(request, address)
1890
except Exception:
1514
except:
1891
1515
self.handle_error(request, address)
1892
1516
self.close_request(request)
1893
1517
1894
1518
def process_request(self, request, address):
1895
1519
"""Start a new process to process the request."""
1896
1520
proc = multiprocessing.Process(target = self.sub_process_main,
1897
args = (request, address))
1521
args = (request,
1522
address))
1898
1523
proc.start()
1899
1524
return proc
1900
1525
1928
1553
use_ipv6: Boolean; to use IPv6 or not
1929
1554
"""
1930
1555
def __init__(self, server_address, RequestHandlerClass,
1931
interface=None, use_ipv6=True, socketfd=None):
1932
"""If socketfd is set, use that file descriptor instead of
1933
creating a new one with socket.socket().
1934
"""
1556
interface=None, use_ipv6=True):
1935
1557
self.interface = interface
1936
1558
if use_ipv6:
1937
1559
self.address_family = socket.AF_INET6
1938
if socketfd is not None:
1939
# Save the file descriptor
1940
self.socketfd = socketfd
1941
# Save the original socket.socket() function
1942
self.socket_socket = socket.socket
1943
# To implement --socket, we monkey patch socket.socket.
1944
#
1945
# (When socketserver.TCPServer is a new-style class, we
1946
# could make self.socket into a property instead of monkey
1947
# patching socket.socket.)
1948
#
1949
# Create a one-time-only replacement for socket.socket()
1950
@functools.wraps(socket.socket)
1951
def socket_wrapper(*args, **kwargs):
1952
# Restore original function so subsequent calls are
1953
# not affected.
1954
socket.socket = self.socket_socket
1955
del self.socket_socket
1956
# This time only, return a new socket object from the
1957
# saved file descriptor.
1958
return socket.fromfd(self.socketfd, *args, **kwargs)
1959
# Replace socket.socket() function with wrapper
1960
socket.socket = socket_wrapper
1961
# The socketserver.TCPServer.__init__ will call
1962
# socket.socket(), which might be our replacement,
1963
# socket_wrapper(), if socketfd was set.
1964
1560
socketserver.TCPServer.__init__(self, server_address,
1965
1561
RequestHandlerClass)
1966
1967
1562
def server_bind(self):
1968
1563
"""This overrides the normal server_bind() function
1969
1564
to bind to an interface if one was specified, and also NOT to
1977
1572
try:
1978
1573
self.socket.setsockopt(socket.SOL_SOCKET,
1979
1574
SO_BINDTODEVICE,
1980
str(self.interface + '\0'))
1575
str(self.interface
1576
+ '\0'))
1981
1577
except socket.error as error:
1982
if error.errno == errno.EPERM:
1983
logger.error("No permission to bind to"
1984
" interface %s", self.interface)
1985
elif error.errno == errno.ENOPROTOOPT:
1578
if error[0] == errno.EPERM:
1579
logger.error("No permission to"
1580
" bind to interface %s",
1581
self.interface)
1582
elif error[0] == errno.ENOPROTOOPT:
1986
1583
logger.error("SO_BINDTODEVICE not available;"
1987
1584
" cannot bind to interface %s",
1988
1585
self.interface)
1989
elif error.errno == errno.ENODEV:
1990
logger.error("Interface %s does not exist,"
1991
" cannot bind", self.interface)
1992
1586
else:
1993
1587
raise
1994
1588
# Only bind(2) the socket if we really need to.
1997
1591
if self.address_family == socket.AF_INET6:
1998
1592
any_address = "::" # in6addr_any
1999
1593
else:
2000
any_address = "0.0.0.0" # INADDR_ANY
1594
any_address = socket.INADDR_ANY
2001
1595
self.server_address = (any_address,
2002
1596
self.server_address[1])
2003
1597
elif not self.server_address[1]:
2024
1618
"""
2025
1619
def __init__(self, server_address, RequestHandlerClass,
2026
1620
interface=None, use_ipv6=True, clients=None,
2027
gnutls_priority=None, use_dbus=True, socketfd=None):
1621
gnutls_priority=None, use_dbus=True):
2028
1622
self.enabled = False
2029
1623
self.clients = clients
2030
1624
if self.clients is None:
2031
self.clients = {}
1625
self.clients = set()
2032
1626
self.use_dbus = use_dbus
2033
1627
self.gnutls_priority = gnutls_priority
2034
1628
IPv6_TCPServer.__init__(self, server_address,
2035
1629
RequestHandlerClass,
2036
1630
interface = interface,
2037
use_ipv6 = use_ipv6,
2038
socketfd = socketfd)
1631
use_ipv6 = use_ipv6)
2039
1632
def server_activate(self):
2040
1633
if self.enabled:
2041
1634
return socketserver.TCPServer.server_activate(self)
2054
1647
2055
1648
def handle_ipc(self, source, condition, parent_pipe=None,
2056
1649
proc = None, client_object=None):
2057
# error, or the other end of multiprocessing.Pipe has closed
2058
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2059
# Wait for other process to exit
1650
condition_names = {
1651
gobject.IO_IN: "IN", # There is data to read.
1652
gobject.IO_OUT: "OUT", # Data can be written (without
1653
# blocking).
1654
gobject.IO_PRI: "PRI", # There is urgent data to read.
1655
gobject.IO_ERR: "ERR", # Error condition.
1656
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1657
# broken, usually for pipes and
1658
# sockets).
1659
}
1660
conditions_string = ' | '.join(name
1661
for cond, name in
1662
condition_names.iteritems()
1663
if cond & condition)
1664
# error or the other end of multiprocessing.Pipe has closed
1665
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2060
1666
proc.join()
2061
1667
return False
2062
1668
2068
1674
fpr = request[1]
2069
1675
address = request[2]
2070
1676
2071
for c in self.clients.itervalues():
1677
for c in self.clients:
2072
1678
if c.fingerprint == fpr:
2073
1679
client = c
2074
1680
break
2119
1725
return True
2120
1726
2121
1727
2122
def rfc3339_duration_to_delta(duration):
2123
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2124
2125
>>> rfc3339_duration_to_delta("P7D")
2126
datetime.timedelta(7)
2127
>>> rfc3339_duration_to_delta("PT60S")
2128
datetime.timedelta(0, 60)
2129
>>> rfc3339_duration_to_delta("PT60M")
2130
datetime.timedelta(0, 3600)
2131
>>> rfc3339_duration_to_delta("PT24H")
2132
datetime.timedelta(1)
2133
>>> rfc3339_duration_to_delta("P1W")
2134
datetime.timedelta(7)
2135
>>> rfc3339_duration_to_delta("PT5M30S")
2136
datetime.timedelta(0, 330)
2137
>>> rfc3339_duration_to_delta("P1DT3M20S")
2138
datetime.timedelta(1, 200)
2139
"""
2140
2141
# Parsing an RFC 3339 duration with regular expressions is not
2142
# possible - there would have to be multiple places for the same
2143
# values, like seconds. The current code, while more esoteric, is
2144
# cleaner without depending on a parsing library. If Python had a
2145
# built-in library for parsing we would use it, but we'd like to
2146
# avoid excessive use of external libraries.
2147
2148
# New type for defining tokens, syntax, and semantics all-in-one
2149
Token = collections.namedtuple("Token",
2150
("regexp", # To match token; if
2151
# "value" is not None,
2152
# must have a "group"
2153
# containing digits
2154
"value", # datetime.timedelta or
2155
# None
2156
"followers")) # Tokens valid after
2157
# this token
2158
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2159
# the "duration" ABNF definition in RFC 3339, Appendix A.
2160
token_end = Token(re.compile(r"$"), None, frozenset())
2161
token_second = Token(re.compile(r"(\d+)S"),
2162
datetime.timedelta(seconds=1),
2163
frozenset((token_end,)))
2164
token_minute = Token(re.compile(r"(\d+)M"),
2165
datetime.timedelta(minutes=1),
2166
frozenset((token_second, token_end)))
2167
token_hour = Token(re.compile(r"(\d+)H"),
2168
datetime.timedelta(hours=1),
2169
frozenset((token_minute, token_end)))
2170
token_time = Token(re.compile(r"T"),
2171
None,
2172
frozenset((token_hour, token_minute,
2173
token_second)))
2174
token_day = Token(re.compile(r"(\d+)D"),
2175
datetime.timedelta(days=1),
2176
frozenset((token_time, token_end)))
2177
token_month = Token(re.compile(r"(\d+)M"),
2178
datetime.timedelta(weeks=4),
2179
frozenset((token_day, token_end)))
2180
token_year = Token(re.compile(r"(\d+)Y"),
2181
datetime.timedelta(weeks=52),
2182
frozenset((token_month, token_end)))
2183
token_week = Token(re.compile(r"(\d+)W"),
2184
datetime.timedelta(weeks=1),
2185
frozenset((token_end,)))
2186
token_duration = Token(re.compile(r"P"), None,
2187
frozenset((token_year, token_month,
2188
token_day, token_time,
2189
token_week))),
2190
# Define starting values
2191
value = datetime.timedelta() # Value so far
2192
found_token = None
2193
followers = frozenset(token_duration,) # Following valid tokens
2194
s = duration # String left to parse
2195
# Loop until end token is found
2196
while found_token is not token_end:
2197
# Search for any currently valid tokens
2198
for token in followers:
2199
match = token.regexp.match(s)
2200
if match is not None:
2201
# Token found
2202
if token.value is not None:
2203
# Value found, parse digits
2204
factor = int(match.group(1), 10)
2205
# Add to value so far
2206
value += factor * token.value
2207
# Strip token from string
2208
s = token.regexp.sub("", s, 1)
2209
# Go to found token
2210
found_token = token
2211
# Set valid next tokens
2212
followers = found_token.followers
2213
break
2214
else:
2215
# No currently valid tokens were found
2216
raise ValueError("Invalid RFC 3339 duration")
2217
# End token found
2218
return value
2219
2220
2221
1728
def string_to_delta(interval):
2222
1729
"""Parse a string and return a datetime.timedelta
2223
1730
2234
1741
>>> string_to_delta('5m 30s')
2235
1742
datetime.timedelta(0, 330)
2236
1743
"""
2237
2238
try:
2239
return rfc3339_duration_to_delta(interval)
2240
except ValueError:
2241
pass
2242
2243
1744
timevalue = datetime.timedelta(0)
2244
1745
for s in interval.split():
2245
1746
try:
2256
1757
elif suffix == "w":
2257
1758
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2258
1759
else:
2259
raise ValueError("Unknown suffix {0!r}"
2260
.format(suffix))
1760
raise ValueError("Unknown suffix %r" % suffix)
2261
1761
except (ValueError, IndexError) as e:
2262
1762
raise ValueError(*(e.args))
2263
1763
timevalue += delta
2264
1764
return timevalue
2265
1765
2266
1766
1767
def if_nametoindex(interface):
1768
"""Call the C function if_nametoindex(), or equivalent
1769
1770
Note: This function cannot accept a unicode string."""
1771
global if_nametoindex
1772
try:
1773
if_nametoindex = (ctypes.cdll.LoadLibrary
1774
(ctypes.util.find_library("c"))
1775
.if_nametoindex)
1776
except (OSError, AttributeError):
1777
logger.warning("Doing if_nametoindex the hard way")
1778
def if_nametoindex(interface):
1779
"Get an interface index the hard way, i.e. using fcntl()"
1780
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1781
with contextlib.closing(socket.socket()) as s:
1782
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1783
struct.pack(str("16s16x"),
1784
interface))
1785
interface_index = struct.unpack(str("I"),
1786
ifreq[16:20])[0]
1787
return interface_index
1788
return if_nametoindex(interface)
1789
1790
2267
1791
def daemon(nochdir = False, noclose = False):
2268
1792
"""See daemon(3). Standard BSD Unix function.
2269
1793
2277
1801
sys.exit()
2278
1802
if not noclose:
2279
1803
# Close all standard open file descriptors
2280
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1804
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2281
1805
if not stat.S_ISCHR(os.fstat(null).st_mode):
2282
1806
raise OSError(errno.ENODEV,
2283
"{0} not a character device"
2284
.format(os.devnull))
1807
"%s not a character device"
1808
% os.path.devnull)
2285
1809
os.dup2(null, sys.stdin.fileno())
2286
1810
os.dup2(null, sys.stdout.fileno())
2287
1811
os.dup2(null, sys.stderr.fileno())
2296
1820
2297
1821
parser = argparse.ArgumentParser()
2298
1822
parser.add_argument("-v", "--version", action="version",
2299
version = "%(prog)s {0}".format(version),
1823
version = "%%(prog)s %s" % version,
2300
1824
help="show version number and exit")
2301
1825
parser.add_argument("-i", "--interface", metavar="IF",
2302
1826
help="Bind to interface IF")
2308
1832
help="Run self-test")
2309
1833
parser.add_argument("--debug", action="store_true",
2310
1834
help="Debug mode; run in foreground and log"
2311
" to terminal", default=None)
1835
" to terminal")
2312
1836
parser.add_argument("--debuglevel", metavar="LEVEL",
2313
1837
help="Debug level for stdout output")
2314
1838
parser.add_argument("--priority", help="GnuTLS"
2321
1845
" files")
2322
1846
parser.add_argument("--no-dbus", action="store_false",
2323
1847
dest="use_dbus", help="Do not provide D-Bus"
2324
" system bus interface", default=None)
1848
" system bus interface")
2325
1849
parser.add_argument("--no-ipv6", action="store_false",
2326
dest="use_ipv6", help="Do not use IPv6",
2327
default=None)
2328
parser.add_argument("--no-restore", action="store_false",
2329
dest="restore", help="Do not restore stored"
2330
" state", default=None)
2331
parser.add_argument("--socket", type=int,
2332
help="Specify a file descriptor to a network"
2333
" socket to use instead of creating one")
2334
parser.add_argument("--statedir", metavar="DIR",
2335
help="Directory to save/restore state in")
2336
parser.add_argument("--foreground", action="store_true",
2337
help="Run in foreground", default=None)
2338
1850
dest="use_ipv6", help="Do not use IPv6")
2339
1851
options = parser.parse_args()
2340
1852
2341
1853
if options.check:
2349
1861
"port": "",
2350
1862
"debug": "False",
2351
1863
"priority":
2352
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1864
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2353
1865
"servicename": "Mandos",
2354
1866
"use_dbus": "True",
2355
1867
"use_ipv6": "True",
2356
1868
"debuglevel": "",
2357
"restore": "True",
2358
"socket": "",
2359
"statedir": "/var/lib/mandos",
2360
"foreground": "False",
2361
1869
}
2362
1870
2363
1871
# Parse config file for server-global settings
2368
1876
# Convert the SafeConfigParser object to a dict
2369
1877
server_settings = server_config.defaults()
2370
1878
# Use the appropriate methods on the non-string config options
2371
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1879
for option in ("debug", "use_dbus", "use_ipv6"):
2372
1880
server_settings[option] = server_config.getboolean("DEFAULT",
2373
1881
option)
2374
1882
if server_settings["port"]:
2375
1883
server_settings["port"] = server_config.getint("DEFAULT",
2376
1884
"port")
2377
if server_settings["socket"]:
2378
server_settings["socket"] = server_config.getint("DEFAULT",
2379
"socket")
2380
# Later, stdin will, and stdout and stderr might, be dup'ed
2381
# over with an opened os.devnull. But we don't want this to
2382
# happen with a supplied network socket.
2383
if 0 <= server_settings["socket"] <= 2:
2384
server_settings["socket"] = os.dup(server_settings
2385
["socket"])
2386
1885
del server_config
2387
1886
2388
1887
# Override the settings from the config file with command line
2389
1888
# options, if set.
2390
1889
for option in ("interface", "address", "port", "debug",
2391
1890
"priority", "servicename", "configdir",
2392
"use_dbus", "use_ipv6", "debuglevel", "restore",
2393
"statedir", "socket", "foreground"):
1891
"use_dbus", "use_ipv6", "debuglevel"):
2394
1892
value = getattr(options, option)
2395
1893
if value is not None:
2396
1894
server_settings[option] = value
2399
1897
for option in server_settings.keys():
2400
1898
if type(server_settings[option]) is str:
2401
1899
server_settings[option] = unicode(server_settings[option])
2402
# Force all boolean options to be boolean
2403
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2404
"foreground"):
2405
server_settings[option] = bool(server_settings[option])
2406
# Debug implies foreground
2407
if server_settings["debug"]:
2408
server_settings["foreground"] = True
2409
1900
# Now we have our good server settings in "server_settings"
2410
1901
2411
1902
##################################################################
2415
1906
debuglevel = server_settings["debuglevel"]
2416
1907
use_dbus = server_settings["use_dbus"]
2417
1908
use_ipv6 = server_settings["use_ipv6"]
2418
stored_state_path = os.path.join(server_settings["statedir"],
2419
stored_state_file)
2420
foreground = server_settings["foreground"]
2421
2422
if debug:
2423
initlogger(debug, logging.DEBUG)
2424
else:
2425
if not debuglevel:
2426
initlogger(debug)
2427
else:
2428
level = getattr(logging, debuglevel.upper())
2429
initlogger(debug, level)
2430
1909
2431
1910
if server_settings["servicename"] != "Mandos":
2432
1911
syslogger.setFormatter(logging.Formatter
2433
('Mandos ({0}) [%(process)d]:'
2434
' %(levelname)s: %(message)s'
2435
.format(server_settings
2436
["servicename"])))
1912
('Mandos (%s) [%%(process)d]:'
1913
' %%(levelname)s: %%(message)s'
1914
% server_settings["servicename"]))
2437
1915
2438
1916
# Parse config file with clients
2439
client_config = configparser.SafeConfigParser(Client
2440
.client_defaults)
1917
client_defaults = { "timeout": "5m",
1918
"extended_timeout": "15m",
1919
"interval": "2m",
1920
"checker": "fping -q -- %%(host)s",
1921
"host": "",
1922
"approval_delay": "0s",
1923
"approval_duration": "1s",
1924
}
1925
client_config = configparser.SafeConfigParser(client_defaults)
2441
1926
client_config.read(os.path.join(server_settings["configdir"],
2442
1927
"clients.conf"))
2443
1928
2452
1937
use_ipv6=use_ipv6,
2453
1938
gnutls_priority=
2454
1939
server_settings["priority"],
2455
use_dbus=use_dbus,
2456
socketfd=(server_settings["socket"]
2457
or None))
2458
if not foreground:
2459
pidfilename = "/run/mandos.pid"
2460
if not os.path.isdir("/run/."):
2461
pidfilename = "/var/run/mandos.pid"
2462
pidfile = None
1940
use_dbus=use_dbus)
1941
if not debug:
1942
pidfilename = "/var/run/mandos.pid"
2463
1943
try:
2464
1944
pidfile = open(pidfilename, "w")
2465
except IOError as e:
2466
logger.error("Could not open file %r", pidfilename,
2467
exc_info=e)
1945
except IOError:
1946
logger.error("Could not open file %r", pidfilename)
2468
1947
2469
for name in ("_mandos", "mandos", "nobody"):
1948
try:
1949
uid = pwd.getpwnam("_mandos").pw_uid
1950
gid = pwd.getpwnam("_mandos").pw_gid
1951
except KeyError:
2470
1952
try:
2471
uid = pwd.getpwnam(name).pw_uid
2472
gid = pwd.getpwnam(name).pw_gid
2473
break
1953
uid = pwd.getpwnam("mandos").pw_uid
1954
gid = pwd.getpwnam("mandos").pw_gid
2474
1955
except KeyError:
2475
continue
2476
else:
2477
uid = 65534
2478
gid = 65534
1956
try:
1957
uid = pwd.getpwnam("nobody").pw_uid
1958
gid = pwd.getpwnam("nobody").pw_gid
1959
except KeyError:
1960
uid = 65534
1961
gid = 65534
2479
1962
try:
2480
1963
os.setgid(gid)
2481
1964
os.setuid(uid)
2482
1965
except OSError as error:
2483
if error.errno != errno.EPERM:
1966
if error[0] != errno.EPERM:
2484
1967
raise error
2485
1968
1969
if not debug and not debuglevel:
1970
syslogger.setLevel(logging.WARNING)
1971
console.setLevel(logging.WARNING)
1972
if debuglevel:
1973
level = getattr(logging, debuglevel.upper())
1974
syslogger.setLevel(level)
1975
console.setLevel(level)
1976
2486
1977
if debug:
2487
1978
# Enable all possible GnuTLS debugging
2488
1979
2498
1989
.gnutls_global_set_log_function(debug_gnutls))
2499
1990
2500
1991
# Redirect stdin so all checkers get /dev/null
2501
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1992
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2502
1993
os.dup2(null, sys.stdin.fileno())
2503
1994
if null > 2:
2504
1995
os.close(null)
1996
else:
1997
# No console logging
1998
logger.removeHandler(console)
2505
1999
2506
2000
# Need to fork before connecting to D-Bus
2507
if not foreground:
2001
if not debug:
2508
2002
# Close all input and output, do double fork, etc.
2509
2003
daemon()
2510
2004
2511
# multiprocessing will use threads, so before we use gobject we
2512
# need to inform gobject that threads will be used.
2513
gobject.threads_init()
2514
2515
2005
global main_loop
2516
2006
# From the Avahi example code
2517
DBusGMainLoop(set_as_default=True)
2007
DBusGMainLoop(set_as_default=True )
2518
2008
main_loop = gobject.MainLoop()
2519
2009
bus = dbus.SystemBus()
2520
2010
# End of Avahi example code
2526
2016
("se.bsnet.fukt.Mandos", bus,
2527
2017
do_not_queue=True))
2528
2018
except dbus.exceptions.NameExistsException as e:
2529
logger.error("Disabling D-Bus:", exc_info=e)
2019
logger.error(unicode(e) + ", disabling D-Bus")
2530
2020
use_dbus = False
2531
2021
server_settings["use_dbus"] = False
2532
2022
tcp_server.use_dbus = False
2533
2023
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2534
service = AvahiServiceToSyslog(name =
2535
server_settings["servicename"],
2536
servicetype = "_mandos._tcp",
2537
protocol = protocol, bus = bus)
2024
service = AvahiService(name = server_settings["servicename"],
2025
servicetype = "_mandos._tcp",
2026
protocol = protocol, bus = bus)
2538
2027
if server_settings["interface"]:
2539
2028
service.interface = (if_nametoindex
2540
2029
(str(server_settings["interface"])))
2544
2033
2545
2034
client_class = Client
2546
2035
if use_dbus:
2547
client_class = functools.partial(ClientDBus, bus = bus)
2548
2549
client_settings = Client.config_parser(client_config)
2550
old_client_settings = {}
2551
clients_data = {}
2552
2553
# This is used to redirect stdout and stderr for checker processes
2554
global wnull
2555
wnull = open(os.devnull, "w") # A writable /dev/null
2556
# Only used if server is running in foreground but not in debug
2557
# mode
2558
if debug or not foreground:
2559
wnull.close()
2560
2561
# Get client data and settings from last running state.
2562
if server_settings["restore"]:
2563
try:
2564
with open(stored_state_path, "rb") as stored_state:
2565
clients_data, old_client_settings = (pickle.load
2566
(stored_state))
2567
os.remove(stored_state_path)
2568
except IOError as e:
2569
if e.errno == errno.ENOENT:
2570
logger.warning("Could not load persistent state: {0}"
2571
.format(os.strerror(e.errno)))
2572
else:
2573
logger.critical("Could not load persistent state:",
2574
exc_info=e)
2575
raise
2576
except EOFError as e:
2577
logger.warning("Could not load persistent state: "
2578
"EOFError:", exc_info=e)
2579
2580
with PGPEngine() as pgp:
2581
for client_name, client in clients_data.iteritems():
2582
# Skip removed clients
2583
if client_name not in client_settings:
2584
continue
2585
2586
# Decide which value to use after restoring saved state.
2587
# We have three different values: Old config file,
2588
# new config file, and saved state.
2589
# New config value takes precedence if it differs from old
2590
# config value, otherwise use saved state.
2591
for name, value in client_settings[client_name].items():
2592
try:
2593
# For each value in new config, check if it
2594
# differs from the old config value (Except for
2595
# the "secret" attribute)
2596
if (name != "secret" and
2597
value != old_client_settings[client_name]
2598
[name]):
2599
client[name] = value
2600
except KeyError:
2601
pass
2602
2603
# Clients who has passed its expire date can still be
2604
# enabled if its last checker was successful. Clients
2605
# whose checker succeeded before we stored its state is
2606
# assumed to have successfully run all checkers during
2607
# downtime.
2608
if client["enabled"]:
2609
if datetime.datetime.utcnow() >= client["expires"]:
2610
if not client["last_checked_ok"]:
2611
logger.warning(
2612
"disabling client {0} - Client never "
2613
"performed a successful checker"
2614
.format(client_name))
2615
client["enabled"] = False
2616
elif client["last_checker_status"] != 0:
2617
logger.warning(
2618
"disabling client {0} - Client "
2619
"last checker failed with error code {1}"
2620
.format(client_name,
2621
client["last_checker_status"]))
2622
client["enabled"] = False
2623
else:
2624
client["expires"] = (datetime.datetime
2625
.utcnow()
2626
+ client["timeout"])
2627
logger.debug("Last checker succeeded,"
2628
" keeping {0} enabled"
2629
.format(client_name))
2036
client_class = functools.partial(ClientDBusTransitional,
2037
bus = bus)
2038
def client_config_items(config, section):
2039
special_settings = {
2040
"approved_by_default":
2041
lambda: config.getboolean(section,
2042
"approved_by_default"),
2043
}
2044
for name, value in config.items(section):
2630
2045
try:
2631
client["secret"] = (
2632
pgp.decrypt(client["encrypted_secret"],
2633
client_settings[client_name]
2634
["secret"]))
2635
except PGPError:
2636
# If decryption fails, we use secret from new settings
2637
logger.debug("Failed to decrypt {0} old secret"
2638
.format(client_name))
2639
client["secret"] = (
2640
client_settings[client_name]["secret"])
2641
2642
# Add/remove clients based on new changes made to config
2643
for client_name in (set(old_client_settings)
2644
- set(client_settings)):
2645
del clients_data[client_name]
2646
for client_name in (set(client_settings)
2647
- set(old_client_settings)):
2648
clients_data[client_name] = client_settings[client_name]
2649
2650
# Create all client objects
2651
for client_name, client in clients_data.iteritems():
2652
tcp_server.clients[client_name] = client_class(
2653
name = client_name, settings = client,
2654
server_settings = server_settings)
2655
2046
yield (name, special_settings[name]())
2047
except KeyError:
2048
yield (name, value)
2049
2050
tcp_server.clients.update(set(
2051
client_class(name = section,
2052
config= dict(client_config_items(
2053
client_config, section)))
2054
for section in client_config.sections()))
2656
2055
if not tcp_server.clients:
2657
2056
logger.warning("No clients defined")
2658
2659
if not foreground:
2660
if pidfile is not None:
2661
try:
2662
with pidfile:
2663
pid = os.getpid()
2664
pidfile.write(str(pid) + "\n".encode("utf-8"))
2665
except IOError:
2666
logger.error("Could not write to file %r with PID %d",
2667
pidfilename, pid)
2668
del pidfile
2057
2058
if not debug:
2059
try:
2060
with pidfile:
2061
pid = os.getpid()
2062
pidfile.write(str(pid) + "\n".encode("utf-8"))
2063
del pidfile
2064
except IOError:
2065
logger.error("Could not write to file %r with PID %d",
2066
pidfilename, pid)
2067
except NameError:
2068
# "pidfile" was never created
2069
pass
2669
2070
del pidfilename
2071
2072
signal.signal(signal.SIGINT, signal.SIG_IGN)
2670
2073
2671
2074
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2672
2075
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2673
2076
2674
2077
if use_dbus:
2675
@alternate_dbus_interfaces({"se.recompile.Mandos":
2676
"se.bsnet.fukt.Mandos"})
2677
class MandosDBusService(DBusObjectWithProperties):
2078
class MandosDBusService(dbus.service.Object):
2678
2079
"""A D-Bus proxy object"""
2679
2080
def __init__(self):
2680
2081
dbus.service.Object.__init__(self, bus, "/")
2681
2082
_interface = "se.recompile.Mandos"
2682
2083
2683
@dbus_interface_annotations(_interface)
2684
def _foo(self):
2685
return { "org.freedesktop.DBus.Property"
2686
".EmitsChangedSignal":
2687
"false"}
2688
2689
2084
@dbus.service.signal(_interface, signature="o")
2690
2085
def ClientAdded(self, objpath):
2691
2086
"D-Bus signal"
2705
2100
def GetAllClients(self):
2706
2101
"D-Bus method"
2707
2102
return dbus.Array(c.dbus_object_path
2708
for c in
2709
tcp_server.clients.itervalues())
2103
for c in tcp_server.clients)
2710
2104
2711
2105
@dbus.service.method(_interface,
2712
2106
out_signature="a{oa{sv}}")
2714
2108
"D-Bus method"
2715
2109
return dbus.Dictionary(
2716
2110
((c.dbus_object_path, c.GetAll(""))
2717
for c in tcp_server.clients.itervalues()),
2111
for c in tcp_server.clients),
2718
2112
signature="oa{sv}")
2719
2113
2720
2114
@dbus.service.method(_interface, in_signature="o")
2721
2115
def RemoveClient(self, object_path):
2722
2116
"D-Bus method"
2723
for c in tcp_server.clients.itervalues():
2117
for c in tcp_server.clients:
2724
2118
if c.dbus_object_path == object_path:
2725
del tcp_server.clients[c.name]
2119
tcp_server.clients.remove(c)
2726
2120
c.remove_from_connection()
2727
2121
# Don't signal anything except ClientRemoved
2728
2122
c.disable(quiet=True)
2733
2127
2734
2128
del _interface
2735
2129
2736
mandos_dbus_service = MandosDBusService()
2130
class MandosDBusServiceTransitional(MandosDBusService):
2131
__metaclass__ = AlternateDBusNamesMetaclass
2132
mandos_dbus_service = MandosDBusServiceTransitional()
2737
2133
2738
2134
def cleanup():
2739
2135
"Cleanup function; run on exit"
2740
2136
service.cleanup()
2741
2137
2742
2138
multiprocessing.active_children()
2743
wnull.close()
2744
if not (tcp_server.clients or client_settings):
2745
return
2746
2747
# Store client before exiting. Secrets are encrypted with key
2748
# based on what config file has. If config file is
2749
# removed/edited, old secret will thus be unrecovable.
2750
clients = {}
2751
with PGPEngine() as pgp:
2752
for client in tcp_server.clients.itervalues():
2753
key = client_settings[client.name]["secret"]
2754
client.encrypted_secret = pgp.encrypt(client.secret,
2755
key)
2756
client_dict = {}
2757
2758
# A list of attributes that can not be pickled
2759
# + secret.
2760
exclude = set(("bus", "changedstate", "secret",
2761
"checker", "server_settings"))
2762
for name, typ in (inspect.getmembers
2763
(dbus.service.Object)):
2764
exclude.add(name)
2765
2766
client_dict["encrypted_secret"] = (client
2767
.encrypted_secret)
2768
for attr in client.client_structure:
2769
if attr not in exclude:
2770
client_dict[attr] = getattr(client, attr)
2771
2772
clients[client.name] = client_dict
2773
del client_settings[client.name]["secret"]
2774
2775
try:
2776
with (tempfile.NamedTemporaryFile
2777
(mode='wb', suffix=".pickle", prefix='clients-',
2778
dir=os.path.dirname(stored_state_path),
2779
delete=False)) as stored_state:
2780
pickle.dump((clients, client_settings), stored_state)
2781
tempname=stored_state.name
2782
os.rename(tempname, stored_state_path)
2783
except (IOError, OSError) as e:
2784
if not debug:
2785
try:
2786
os.remove(tempname)
2787
except NameError:
2788
pass
2789
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2790
logger.warning("Could not save persistent state: {0}"
2791
.format(os.strerror(e.errno)))
2792
else:
2793
logger.warning("Could not save persistent state:",
2794
exc_info=e)
2795
raise e
2796
2797
# Delete all clients, and settings from config
2798
2139
while tcp_server.clients:
2799
name, client = tcp_server.clients.popitem()
2140
client = tcp_server.clients.pop()
2800
2141
if use_dbus:
2801
2142
client.remove_from_connection()
2143
client.disable_hook = None
2802
2144
# Don't signal anything except ClientRemoved
2803
2145
client.disable(quiet=True)
2804
2146
if use_dbus:
2806
2148
mandos_dbus_service.ClientRemoved(client
2807
2149
.dbus_object_path,
2808
2150
client.name)
2809
client_settings.clear()
2810
2151
2811
2152
atexit.register(cleanup)
2812
2153
2813
for client in tcp_server.clients.itervalues():
2154
for client in tcp_server.clients:
2814
2155
if use_dbus:
2815
2156
# Emit D-Bus signal
2816
2157
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2817
# Need to initiate checking of clients
2818
if client.enabled:
2819
client.init_checker()
2158
client.enable()
2820
2159
2821
2160
tcp_server.enable()
2822
2161
tcp_server.server_activate()
2825
2164
service.port = tcp_server.socket.getsockname()[1]
2826
2165
if use_ipv6:
2827
2166
logger.info("Now listening on address %r, port %d,"
2828
" flowinfo %d, scope_id %d",
2829
*tcp_server.socket.getsockname())
2167
" flowinfo %d, scope_id %d"
2168
% tcp_server.socket.getsockname())
2830
2169
else: # IPv4
2831
logger.info("Now listening on address %r, port %d",
2832
*tcp_server.socket.getsockname())
2170
logger.info("Now listening on address %r, port %d"
2171
% tcp_server.socket.getsockname())
2833
2172
2834
2173
#service.interface = tcp_server.socket.getsockname()[3]
2835
2174
2838
2177
try:
2839
2178
service.activate()
2840
2179
except dbus.exceptions.DBusException as error:
2841
logger.critical("D-Bus Exception", exc_info=error)
2180
logger.critical("DBusException: %s", error)
2842
2181
cleanup()
2843
2182
sys.exit(1)
2844
2183
# End of Avahi example code
2851
2190
logger.debug("Starting main loop")
2852
2191
main_loop.run()
2853
2192
except AvahiError as error:
2854
logger.critical("Avahi Error", exc_info=error)
2193
logger.critical("AvahiError: %s", error)
2855
2194
cleanup()
2856
2195
sys.exit(1)
2857
2196
except KeyboardInterrupt:
2862
2201
# Must run before the D-Bus bus name gets deregistered
2863
2202
cleanup()
2864
2203
2204
2865
2205
if __name__ == '__main__':
2866
2206
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0