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 24.1.186
- compare with another revision
- download diff
- download tarball
- view history from revision 24.1.186
- Committer: Björn Påhlsson
- Date: 2011-10-02 19:18:24 UTC
- mto: This revision was merged to the branch mainline in revision 505.
- Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API
documented change to D-Bus API
- 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-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 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
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@recompile.se>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
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
79
73
import ctypes.util
80
74
import xml.dom.minidom
81
75
import inspect
82
import GnuPGInterface
83
76
84
77
try:
85
78
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
89
82
except ImportError:
90
83
SO_BINDTODEVICE = None
91
84
92
version = "1.6.0"
93
stored_state_file = "clients.pickle"
94
95
logger = logging.getLogger()
85
86
version = "1.3.1"
87
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
96
90
syslogger = (logging.handlers.SysLogHandler
97
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
98
92
address = str("/dev/log")))
99
100
try:
101
if_nametoindex = (ctypes.cdll.LoadLibrary
102
(ctypes.util.find_library("c"))
103
.if_nametoindex)
104
except (OSError, AttributeError):
105
def if_nametoindex(interface):
106
"Get an interface index the hard way, i.e. using fcntl()"
107
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
108
with contextlib.closing(socket.socket()) as s:
109
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
110
struct.pack(str("16s16x"),
111
interface))
112
interface_index = struct.unpack(str("I"),
113
ifreq[16:20])[0]
114
return interface_index
115
116
117
def initlogger(debug, level=logging.WARNING):
118
"""init logger and add loglevel"""
119
120
syslogger.setFormatter(logging.Formatter
121
('Mandos [%(process)d]: %(levelname)s:'
122
' %(message)s'))
123
logger.addHandler(syslogger)
124
125
if debug:
126
console = logging.StreamHandler()
127
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
128
' [%(process)d]:'
129
' %(levelname)s:'
130
' %(message)s'))
131
logger.addHandler(console)
132
logger.setLevel(level)
133
134
135
class PGPError(Exception):
136
"""Exception if encryption/decryption fails"""
137
pass
138
139
140
class PGPEngine(object):
141
"""A simple class for OpenPGP symmetric encryption & decryption"""
142
def __init__(self):
143
self.gnupg = GnuPGInterface.GnuPG()
144
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
145
self.gnupg = GnuPGInterface.GnuPG()
146
self.gnupg.options.meta_interactive = False
147
self.gnupg.options.homedir = self.tempdir
148
self.gnupg.options.extra_args.extend(['--force-mdc',
149
'--quiet',
150
'--no-use-agent'])
151
152
def __enter__(self):
153
return self
154
155
def __exit__(self, exc_type, exc_value, traceback):
156
self._cleanup()
157
return False
158
159
def __del__(self):
160
self._cleanup()
161
162
def _cleanup(self):
163
if self.tempdir is not None:
164
# Delete contents of tempdir
165
for root, dirs, files in os.walk(self.tempdir,
166
topdown = False):
167
for filename in files:
168
os.remove(os.path.join(root, filename))
169
for dirname in dirs:
170
os.rmdir(os.path.join(root, dirname))
171
# Remove tempdir
172
os.rmdir(self.tempdir)
173
self.tempdir = None
174
175
def password_encode(self, password):
176
# Passphrase can not be empty and can not contain newlines or
177
# NUL bytes. So we prefix it and hex encode it.
178
return b"mandos" + binascii.hexlify(password)
179
180
def encrypt(self, data, password):
181
self.gnupg.passphrase = self.password_encode(password)
182
with open(os.devnull, "w") as devnull:
183
try:
184
proc = self.gnupg.run(['--symmetric'],
185
create_fhs=['stdin', 'stdout'],
186
attach_fhs={'stderr': devnull})
187
with contextlib.closing(proc.handles['stdin']) as f:
188
f.write(data)
189
with contextlib.closing(proc.handles['stdout']) as f:
190
ciphertext = f.read()
191
proc.wait()
192
except IOError as e:
193
raise PGPError(e)
194
self.gnupg.passphrase = None
195
return ciphertext
196
197
def decrypt(self, data, password):
198
self.gnupg.passphrase = self.password_encode(password)
199
with open(os.devnull, "w") as devnull:
200
try:
201
proc = self.gnupg.run(['--decrypt'],
202
create_fhs=['stdin', 'stdout'],
203
attach_fhs={'stderr': devnull})
204
with contextlib.closing(proc.handles['stdin']) as f:
205
f.write(data)
206
with contextlib.closing(proc.handles['stdout']) as f:
207
decrypted_plaintext = f.read()
208
proc.wait()
209
except IOError as e:
210
raise PGPError(e)
211
self.gnupg.passphrase = None
212
return decrypted_plaintext
213
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)
214
103
215
104
class AvahiError(Exception):
216
105
def __init__(self, value, *args, **kwargs):
246
135
server: D-Bus Server
247
136
bus: dbus.SystemBus()
248
137
"""
249
250
138
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
251
139
servicetype = None, port = None, TXT = None,
252
140
domain = "", host = "", max_renames = 32768,
265
153
self.server = None
266
154
self.bus = bus
267
155
self.entry_group_state_changed_match = None
268
269
156
def rename(self):
270
157
"""Derived from the Avahi example code"""
271
158
if self.rename_count >= self.max_renames:
273
160
" after %i retries, exiting.",
274
161
self.rename_count)
275
162
raise AvahiServiceError("Too many renames")
276
self.name = unicode(self.server
277
.GetAlternativeServiceName(self.name))
163
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
278
164
logger.info("Changing Zeroconf service name to %r ...",
279
165
self.name)
166
syslogger.setFormatter(logging.Formatter
167
('Mandos (%s) [%%(process)d]:'
168
' %%(levelname)s: %%(message)s'
169
% self.name))
280
170
self.remove()
281
171
try:
282
172
self.add()
283
173
except dbus.exceptions.DBusException as error:
284
logger.critical("D-Bus Exception", exc_info=error)
174
logger.critical("DBusException: %s", error)
285
175
self.cleanup()
286
176
os._exit(1)
287
177
self.rename_count += 1
288
289
178
def remove(self):
290
179
"""Derived from the Avahi example code"""
291
180
if self.entry_group_state_changed_match is not None:
293
182
self.entry_group_state_changed_match = None
294
183
if self.group is not None:
295
184
self.group.Reset()
296
297
185
def add(self):
298
186
"""Derived from the Avahi example code"""
299
187
self.remove()
304
192
avahi.DBUS_INTERFACE_ENTRY_GROUP)
305
193
self.entry_group_state_changed_match = (
306
194
self.group.connect_to_signal(
307
'StateChanged', self.entry_group_state_changed))
195
'StateChanged', self .entry_group_state_changed))
308
196
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
309
197
self.name, self.type)
310
198
self.group.AddService(
316
204
dbus.UInt16(self.port),
317
205
avahi.string_array_to_txt_array(self.TXT))
318
206
self.group.Commit()
319
320
207
def entry_group_state_changed(self, state, error):
321
208
"""Derived from the Avahi example code"""
322
209
logger.debug("Avahi entry group state change: %i", state)
329
216
elif state == avahi.ENTRY_GROUP_FAILURE:
330
217
logger.critical("Avahi: Error in group state changed %s",
331
218
unicode(error))
332
raise AvahiGroupError("State changed: {0!s}"
333
.format(error))
334
219
raise AvahiGroupError("State changed: %s"
220
% unicode(error))
335
221
def cleanup(self):
336
222
"""Derived from the Avahi example code"""
337
223
if self.group is not None:
338
224
try:
339
225
self.group.Free()
340
226
except (dbus.exceptions.UnknownMethodException,
341
dbus.exceptions.DBusException):
227
dbus.exceptions.DBusException) as e:
342
228
pass
343
229
self.group = None
344
230
self.remove()
345
346
231
def server_state_changed(self, state, error=None):
347
232
"""Derived from the Avahi example code"""
348
233
logger.debug("Avahi server state change: %i", state)
367
252
logger.debug("Unknown state: %r", state)
368
253
else:
369
254
logger.debug("Unknown state: %r: %r", state, error)
370
371
255
def activate(self):
372
256
"""Derived from the Avahi example code"""
373
257
if self.server is None:
381
265
self.server_state_changed(self.server.GetState())
382
266
383
267
384
class AvahiServiceToSyslog(AvahiService):
385
def rename(self):
386
"""Add the new name to the syslog messages"""
387
ret = AvahiService.rename(self)
388
syslogger.setFormatter(logging.Formatter
389
('Mandos ({0}) [%(process)d]:'
390
' %(levelname)s: %(message)s'
391
.format(self.name)))
392
return ret
393
394
395
def timedelta_to_milliseconds(td):
268
def _timedelta_to_milliseconds(td):
396
269
"Convert a datetime.timedelta() to milliseconds"
397
270
return ((td.days * 24 * 60 * 60 * 1000)
398
271
+ (td.seconds * 1000)
399
272
+ (td.microseconds // 1000))
400
401
273
402
274
class Client(object):
403
275
"""A representation of a client host served by this server.
404
276
405
277
Attributes:
406
approved: bool(); 'None' if not yet approved/disapproved
278
_approved: bool(); 'None' if not yet approved/disapproved
407
279
approval_delay: datetime.timedelta(); Time to wait for approval
408
280
approval_duration: datetime.timedelta(); Duration of one approval
409
281
checker: subprocess.Popen(); a running checker process used
416
288
instance %(name)s can be used in the command.
417
289
checker_initiator_tag: a gobject event source tag, or None
418
290
created: datetime.datetime(); (UTC) object creation
419
client_structure: Object describing what attributes a client has
420
and is used for storing the client at exit
421
291
current_checker_command: string; current running checker_command
292
disable_hook: If set, called by disable() as disable_hook(self)
422
293
disable_initiator_tag: a gobject event source tag, or None
423
294
enabled: bool()
424
295
fingerprint: string (40 or 32 hexadecimal digits); used to
427
298
interval: datetime.timedelta(); How often to start a new checker
428
299
last_approval_request: datetime.datetime(); (UTC) or None
429
300
last_checked_ok: datetime.datetime(); (UTC) or None
430
last_checker_status: integer between 0 and 255 reflecting exit
431
status of last checker. -1 reflects crashed
432
checker, -2 means no checker completed yet.
433
last_enabled: datetime.datetime(); (UTC) or None
301
last_enabled: datetime.datetime(); (UTC)
434
302
name: string; from the config file, used in log messages and
435
303
D-Bus identifiers
436
304
secret: bytestring; sent verbatim (over TLS) to client
437
305
timeout: datetime.timedelta(); How long from last_checked_ok
438
306
until this client is disabled
439
extended_timeout: extra long timeout when secret has been sent
307
extended_timeout: extra long timeout when password has been sent
440
308
runtime_expansions: Allowed attributes for runtime expansion.
441
309
expires: datetime.datetime(); time (UTC) when a client will be
442
310
disabled, or None
443
311
"""
444
312
445
313
runtime_expansions = ("approval_delay", "approval_duration",
446
"created", "enabled", "expires",
447
"fingerprint", "host", "interval",
448
"last_approval_request", "last_checked_ok",
314
"created", "enabled", "fingerprint",
315
"host", "interval", "last_checked_ok",
449
316
"last_enabled", "name", "timeout")
450
client_defaults = { "timeout": "PT5M",
451
"extended_timeout": "PT15M",
452
"interval": "PT2M",
453
"checker": "fping -q -- %%(host)s",
454
"host": "",
455
"approval_delay": "PT0S",
456
"approval_duration": "PT1S",
457
"approved_by_default": "True",
458
"enabled": "True",
459
}
460
317
461
318
def timeout_milliseconds(self):
462
319
"Return the 'timeout' attribute in milliseconds"
463
return timedelta_to_milliseconds(self.timeout)
320
return _timedelta_to_milliseconds(self.timeout)
464
321
465
322
def extended_timeout_milliseconds(self):
466
323
"Return the 'extended_timeout' attribute in milliseconds"
467
return timedelta_to_milliseconds(self.extended_timeout)
324
return _timedelta_to_milliseconds(self.extended_timeout)
468
325
469
326
def interval_milliseconds(self):
470
327
"Return the 'interval' attribute in milliseconds"
471
return timedelta_to_milliseconds(self.interval)
328
return _timedelta_to_milliseconds(self.interval)
472
329
473
330
def approval_delay_milliseconds(self):
474
return timedelta_to_milliseconds(self.approval_delay)
475
476
@staticmethod
477
def config_parser(config):
478
"""Construct a new dict of client settings of this form:
479
{ client_name: {setting_name: value, ...}, ...}
480
with exceptions for any special settings as defined above.
481
NOTE: Must be a pure function. Must return the same result
482
value given the same arguments.
483
"""
484
settings = {}
485
for client_name in config.sections():
486
section = dict(config.items(client_name))
487
client = settings[client_name] = {}
488
489
client["host"] = section["host"]
490
# Reformat values from string types to Python types
491
client["approved_by_default"] = config.getboolean(
492
client_name, "approved_by_default")
493
client["enabled"] = config.getboolean(client_name,
494
"enabled")
495
496
client["fingerprint"] = (section["fingerprint"].upper()
497
.replace(" ", ""))
498
if "secret" in section:
499
client["secret"] = section["secret"].decode("base64")
500
elif "secfile" in section:
501
with open(os.path.expanduser(os.path.expandvars
502
(section["secfile"])),
503
"rb") as secfile:
504
client["secret"] = secfile.read()
505
else:
506
raise TypeError("No secret or secfile for section {0}"
507
.format(section))
508
client["timeout"] = string_to_delta(section["timeout"])
509
client["extended_timeout"] = string_to_delta(
510
section["extended_timeout"])
511
client["interval"] = string_to_delta(section["interval"])
512
client["approval_delay"] = string_to_delta(
513
section["approval_delay"])
514
client["approval_duration"] = string_to_delta(
515
section["approval_duration"])
516
client["checker_command"] = section["checker"]
517
client["last_approval_request"] = None
518
client["last_checked_ok"] = None
519
client["last_checker_status"] = -2
520
521
return settings
522
523
def __init__(self, settings, name = None):
331
return _timedelta_to_milliseconds(self.approval_delay)
332
333
def __init__(self, name = None, disable_hook=None, config=None):
334
"""Note: the 'checker' key in 'config' sets the
335
'checker_command' attribute and *not* the 'checker'
336
attribute."""
524
337
self.name = name
525
# adding all client settings
526
for setting, value in settings.iteritems():
527
setattr(self, setting, value)
528
529
if self.enabled:
530
if not hasattr(self, "last_enabled"):
531
self.last_enabled = datetime.datetime.utcnow()
532
if not hasattr(self, "expires"):
533
self.expires = (datetime.datetime.utcnow()
534
+ self.timeout)
535
else:
536
self.last_enabled = None
537
self.expires = None
538
338
if config is None:
339
config = {}
539
340
logger.debug("Creating client %r", self.name)
540
341
# Uppercase and remove spaces from fingerprint for later
541
342
# comparison purposes with return value from the fingerprint()
542
343
# function
344
self.fingerprint = (config["fingerprint"].upper()
345
.replace(" ", ""))
543
346
logger.debug(" Fingerprint: %s", self.fingerprint)
544
self.created = settings.get("created",
545
datetime.datetime.utcnow())
546
547
# attributes specific for this server instance
347
if "secret" in config:
348
self.secret = config["secret"].decode("base64")
349
elif "secfile" in config:
350
with open(os.path.expanduser(os.path.expandvars
351
(config["secfile"])),
352
"rb") as secfile:
353
self.secret = secfile.read()
354
else:
355
raise TypeError("No secret or secfile for client %s"
356
% self.name)
357
self.host = config.get("host", "")
358
self.created = datetime.datetime.utcnow()
359
self.enabled = False
360
self.last_approval_request = None
361
self.last_enabled = None
362
self.last_checked_ok = None
363
self.timeout = string_to_delta(config["timeout"])
364
self.extended_timeout = string_to_delta(config["extended_timeout"])
365
self.interval = string_to_delta(config["interval"])
366
self.disable_hook = disable_hook
548
367
self.checker = None
549
368
self.checker_initiator_tag = None
550
369
self.disable_initiator_tag = None
370
self.expires = None
551
371
self.checker_callback_tag = None
372
self.checker_command = config["checker"]
552
373
self.current_checker_command = None
553
self.approved = None
374
self.last_connect = None
375
self._approved = None
376
self.approved_by_default = config.get("approved_by_default",
377
True)
554
378
self.approvals_pending = 0
555
self.changedstate = (multiprocessing_manager
556
.Condition(multiprocessing_manager
557
.Lock()))
558
self.client_structure = [attr for attr in
559
self.__dict__.iterkeys()
560
if not attr.startswith("_")]
561
self.client_structure.append("client_structure")
562
563
for name, t in inspect.getmembers(type(self),
564
lambda obj:
565
isinstance(obj,
566
property)):
567
if not name.startswith("_"):
568
self.client_structure.append(name)
379
self.approval_delay = string_to_delta(
380
config["approval_delay"])
381
self.approval_duration = string_to_delta(
382
config["approval_duration"])
383
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
569
384
570
# Send notice to process children that client state has changed
571
385
def send_changedstate(self):
572
with self.changedstate:
573
self.changedstate.notify_all()
574
386
self.changedstate.acquire()
387
self.changedstate.notify_all()
388
self.changedstate.release()
389
575
390
def enable(self):
576
391
"""Start this client's checker and timeout hooks"""
577
392
if getattr(self, "enabled", False):
578
393
# Already enabled
579
394
return
395
self.send_changedstate()
396
# Schedule a new checker to be started an 'interval' from now,
397
# and every interval from then on.
398
self.checker_initiator_tag = (gobject.timeout_add
399
(self.interval_milliseconds(),
400
self.start_checker))
401
# Schedule a disable() when 'timeout' has passed
580
402
self.expires = datetime.datetime.utcnow() + self.timeout
403
self.disable_initiator_tag = (gobject.timeout_add
404
(self.timeout_milliseconds(),
405
self.disable))
581
406
self.enabled = True
582
407
self.last_enabled = datetime.datetime.utcnow()
583
self.init_checker()
584
self.send_changedstate()
408
# Also start a new checker *right now*.
409
self.start_checker()
585
410
586
411
def disable(self, quiet=True):
587
412
"""Disable this client."""
588
413
if not getattr(self, "enabled", False):
589
414
return False
590
415
if not quiet:
416
self.send_changedstate()
417
if not quiet:
591
418
logger.info("Disabling client %s", self.name)
592
if getattr(self, "disable_initiator_tag", None) is not None:
419
if getattr(self, "disable_initiator_tag", False):
593
420
gobject.source_remove(self.disable_initiator_tag)
594
421
self.disable_initiator_tag = None
595
422
self.expires = None
596
if getattr(self, "checker_initiator_tag", None) is not None:
423
if getattr(self, "checker_initiator_tag", False):
597
424
gobject.source_remove(self.checker_initiator_tag)
598
425
self.checker_initiator_tag = None
599
426
self.stop_checker()
427
if self.disable_hook:
428
self.disable_hook(self)
600
429
self.enabled = False
601
if not quiet:
602
self.send_changedstate()
603
430
# Do not run this again if called by a gobject.timeout_add
604
431
return False
605
432
606
433
def __del__(self):
434
self.disable_hook = None
607
435
self.disable()
608
436
609
def init_checker(self):
610
# Schedule a new checker to be started an 'interval' from now,
611
# and every interval from then on.
612
if self.checker_initiator_tag is not None:
613
gobject.source_remove(self.checker_initiator_tag)
614
self.checker_initiator_tag = (gobject.timeout_add
615
(self.interval_milliseconds(),
616
self.start_checker))
617
# Schedule a disable() when 'timeout' has passed
618
if self.disable_initiator_tag is not None:
619
gobject.source_remove(self.disable_initiator_tag)
620
self.disable_initiator_tag = (gobject.timeout_add
621
(self.timeout_milliseconds(),
622
self.disable))
623
# Also start a new checker *right now*.
624
self.start_checker()
625
626
437
def checker_callback(self, pid, condition, command):
627
438
"""The checker has completed, so take appropriate actions."""
628
439
self.checker_callback_tag = None
629
440
self.checker = None
630
441
if os.WIFEXITED(condition):
631
self.last_checker_status = os.WEXITSTATUS(condition)
632
if self.last_checker_status == 0:
442
exitstatus = os.WEXITSTATUS(condition)
443
if exitstatus == 0:
633
444
logger.info("Checker for %(name)s succeeded",
634
445
vars(self))
635
446
self.checked_ok()
637
448
logger.info("Checker for %(name)s failed",
638
449
vars(self))
639
450
else:
640
self.last_checker_status = -1
641
451
logger.warning("Checker for %(name)s crashed?",
642
452
vars(self))
643
453
644
def checked_ok(self):
645
"""Assert that the client has been seen, alive and well."""
646
self.last_checked_ok = datetime.datetime.utcnow()
647
self.last_checker_status = 0
648
self.bump_timeout()
649
650
def bump_timeout(self, timeout=None):
651
"""Bump up the timeout for this client."""
454
def checked_ok(self, timeout=None):
455
"""Bump up the timeout for this client.
456
457
This should only be called when the client has been seen,
458
alive and well.
459
"""
652
460
if timeout is None:
653
461
timeout = self.timeout
654
if self.disable_initiator_tag is not None:
655
gobject.source_remove(self.disable_initiator_tag)
656
self.disable_initiator_tag = None
657
if getattr(self, "enabled", False):
658
self.disable_initiator_tag = (gobject.timeout_add
659
(timedelta_to_milliseconds
660
(timeout), self.disable))
661
self.expires = datetime.datetime.utcnow() + timeout
462
self.last_checked_ok = datetime.datetime.utcnow()
463
gobject.source_remove(self.disable_initiator_tag)
464
self.expires = datetime.datetime.utcnow() + timeout
465
self.disable_initiator_tag = (gobject.timeout_add
466
(_timedelta_to_milliseconds(timeout),
467
self.disable))
662
468
663
469
def need_approval(self):
664
470
self.last_approval_request = datetime.datetime.utcnow()
669
475
If a checker already exists, leave it running and do
670
476
nothing."""
671
477
# The reason for not killing a running checker is that if we
672
# did that, and if a checker (for some reason) started running
673
# slowly and taking more than 'interval' time, then the client
674
# would inevitably timeout, since no checker would get a
675
# chance to run to completion. If we instead leave running
478
# did that, then if a checker (for some reason) started
479
# running slowly and taking more than 'interval' time, the
480
# client would inevitably timeout, since no checker would get
481
# a chance to run to completion. If we instead leave running
676
482
# checkers alone, the checker would have to take more time
677
483
# than 'timeout' for the client to be disabled, which is as it
678
484
# should be.
692
498
self.current_checker_command)
693
499
# Start a new checker if needed
694
500
if self.checker is None:
695
# Escape attributes for the shell
696
escaped_attrs = dict(
697
(attr, re.escape(unicode(getattr(self, attr))))
698
for attr in
699
self.runtime_expansions)
700
501
try:
701
command = self.checker_command % escaped_attrs
702
except TypeError as error:
703
logger.error('Could not format string "%s"',
704
self.checker_command, exc_info=error)
705
return True # Try again later
502
# In case checker_command has exactly one % operator
503
command = self.checker_command % self.host
504
except TypeError:
505
# Escape attributes for the shell
506
escaped_attrs = dict(
507
(attr,
508
re.escape(unicode(str(getattr(self, attr, "")),
509
errors=
510
'replace')))
511
for attr in
512
self.runtime_expansions)
513
514
try:
515
command = self.checker_command % escaped_attrs
516
except TypeError as error:
517
logger.error('Could not format string "%s":'
518
' %s', self.checker_command, error)
519
return True # Try again later
706
520
self.current_checker_command = command
707
521
try:
708
522
logger.info("Starting checker %r for %s",
714
528
self.checker = subprocess.Popen(command,
715
529
close_fds=True,
716
530
shell=True, cwd="/")
531
self.checker_callback_tag = (gobject.child_watch_add
532
(self.checker.pid,
533
self.checker_callback,
534
data=command))
535
# The checker may have completed before the gobject
536
# watch was added. Check for this.
537
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
538
if pid:
539
gobject.source_remove(self.checker_callback_tag)
540
self.checker_callback(pid, status, command)
717
541
except OSError as error:
718
logger.error("Failed to start subprocess",
719
exc_info=error)
720
self.checker_callback_tag = (gobject.child_watch_add
721
(self.checker.pid,
722
self.checker_callback,
723
data=command))
724
# The checker may have completed before the gobject
725
# watch was added. Check for this.
726
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
727
if pid:
728
gobject.source_remove(self.checker_callback_tag)
729
self.checker_callback(pid, status, command)
542
logger.error("Failed to start subprocess: %s",
543
error)
730
544
# Re-run this periodically if run by gobject.timeout_add
731
545
return True
732
546
739
553
return
740
554
logger.debug("Stopping checker for %(name)s", vars(self))
741
555
try:
742
self.checker.terminate()
556
os.kill(self.checker.pid, signal.SIGTERM)
743
557
#time.sleep(0.5)
744
558
#if self.checker.poll() is None:
745
# self.checker.kill()
559
# os.kill(self.checker.pid, signal.SIGKILL)
746
560
except OSError as error:
747
561
if error.errno != errno.ESRCH: # No such process
748
562
raise
765
579
# "Set" method, so we fail early here:
766
580
if byte_arrays and signature != "ay":
767
581
raise ValueError("Byte arrays not supported for non-'ay'"
768
" signature {0!r}".format(signature))
582
" signature %r" % signature)
769
583
def decorator(func):
770
584
func._dbus_is_property = True
771
585
func._dbus_interface = dbus_interface
779
593
return decorator
780
594
781
595
782
def dbus_interface_annotations(dbus_interface):
783
"""Decorator for marking functions returning interface annotations
784
785
Usage:
786
787
@dbus_interface_annotations("org.example.Interface")
788
def _foo(self): # Function name does not matter
789
return {"org.freedesktop.DBus.Deprecated": "true",
790
"org.freedesktop.DBus.Property.EmitsChangedSignal":
791
"false"}
792
"""
793
def decorator(func):
794
func._dbus_is_interface = True
795
func._dbus_interface = dbus_interface
796
func._dbus_name = dbus_interface
797
return func
798
return decorator
799
800
801
def dbus_annotations(annotations):
802
"""Decorator to annotate D-Bus methods, signals or properties
803
Usage:
804
805
@dbus_service_property("org.example.Interface", signature="b",
806
access="r")
807
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
808
"org.freedesktop.DBus.Property."
809
"EmitsChangedSignal": "false"})
810
def Property_dbus_property(self):
811
return dbus.Boolean(False)
812
"""
813
def decorator(func):
814
func._dbus_annotations = annotations
815
return func
816
return decorator
817
818
819
596
class DBusPropertyException(dbus.exceptions.DBusException):
820
597
"""A base class for D-Bus property-related exceptions
821
598
"""
844
621
"""
845
622
846
623
@staticmethod
847
def _is_dbus_thing(thing):
848
"""Returns a function testing if an attribute is a D-Bus thing
849
850
If called like _is_dbus_thing("method") it returns a function
851
suitable for use as predicate to inspect.getmembers().
852
"""
853
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
854
False)
624
def _is_dbus_property(obj):
625
return getattr(obj, "_dbus_is_property", False)
855
626
856
def _get_all_dbus_things(self, thing):
627
def _get_all_dbus_properties(self):
857
628
"""Returns a generator of (name, attribute) pairs
858
629
"""
859
return ((getattr(athing.__get__(self), "_dbus_name",
860
name),
861
athing.__get__(self))
630
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
862
631
for cls in self.__class__.__mro__
863
for name, athing in
864
inspect.getmembers(cls,
865
self._is_dbus_thing(thing)))
632
for name, prop in inspect.getmembers(cls, self._is_dbus_property))
866
633
867
634
def _get_dbus_property(self, interface_name, property_name):
868
635
"""Returns a bound method if one exists which is a D-Bus
869
636
property with the specified name and interface.
870
637
"""
871
638
for cls in self.__class__.__mro__:
872
for name, value in (inspect.getmembers
873
(cls,
874
self._is_dbus_thing("property"))):
875
if (value._dbus_name == property_name
876
and value._dbus_interface == interface_name):
639
for name, value in inspect.getmembers(cls, self._is_dbus_property):
640
if value._dbus_name == property_name and value._dbus_interface == interface_name:
877
641
return value.__get__(self)
878
642
879
643
# No such property
880
644
raise DBusPropertyNotFound(self.dbus_object_path + ":"
881
645
+ interface_name + "."
882
646
+ property_name)
647
883
648
884
649
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
885
650
out_signature="v")
906
671
# signatures other than "ay".
907
672
if prop._dbus_signature != "ay":
908
673
raise ValueError
909
value = dbus.ByteArray(b''.join(chr(byte)
910
for byte in value))
674
value = dbus.ByteArray(''.join(unichr(byte)
675
for byte in value))
911
676
prop(value)
912
677
913
678
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
918
683
919
684
Note: Will not include properties with access="write".
920
685
"""
921
properties = {}
922
for name, prop in self._get_all_dbus_things("property"):
686
all = {}
687
for name, prop in self._get_all_dbus_properties():
923
688
if (interface_name
924
689
and interface_name != prop._dbus_interface):
925
690
# Interface non-empty but did not match
929
694
continue
930
695
value = prop()
931
696
if not hasattr(value, "variant_level"):
932
properties[name] = value
697
all[name] = value
933
698
continue
934
properties[name] = type(value)(value, variant_level=
935
value.variant_level+1)
936
return dbus.Dictionary(properties, signature="sv")
699
all[name] = type(value)(value, variant_level=
700
value.variant_level+1)
701
return dbus.Dictionary(all, signature="sv")
937
702
938
703
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
939
704
out_signature="s",
940
705
path_keyword='object_path',
941
706
connection_keyword='connection')
942
707
def Introspect(self, object_path, connection):
943
"""Overloading of standard D-Bus method.
944
945
Inserts property tags and interface annotation tags.
708
"""Standard D-Bus method, overloaded to insert property tags.
946
709
"""
947
710
xmlstring = dbus.service.Object.Introspect(self, object_path,
948
711
connection)
955
718
e.setAttribute("access", prop._dbus_access)
956
719
return e
957
720
for if_tag in document.getElementsByTagName("interface"):
958
# Add property tags
959
721
for tag in (make_tag(document, name, prop)
960
722
for name, prop
961
in self._get_all_dbus_things("property")
723
in self._get_all_dbus_properties()
962
724
if prop._dbus_interface
963
725
== if_tag.getAttribute("name")):
964
726
if_tag.appendChild(tag)
965
# Add annotation tags
966
for typ in ("method", "signal", "property"):
967
for tag in if_tag.getElementsByTagName(typ):
968
annots = dict()
969
for name, prop in (self.
970
_get_all_dbus_things(typ)):
971
if (name == tag.getAttribute("name")
972
and prop._dbus_interface
973
== if_tag.getAttribute("name")):
974
annots.update(getattr
975
(prop,
976
"_dbus_annotations",
977
{}))
978
for name, value in annots.iteritems():
979
ann_tag = document.createElement(
980
"annotation")
981
ann_tag.setAttribute("name", name)
982
ann_tag.setAttribute("value", value)
983
tag.appendChild(ann_tag)
984
# Add interface annotation tags
985
for annotation, value in dict(
986
itertools.chain.from_iterable(
987
annotations().iteritems()
988
for name, annotations in
989
self._get_all_dbus_things("interface")
990
if name == if_tag.getAttribute("name")
991
)).iteritems():
992
ann_tag = document.createElement("annotation")
993
ann_tag.setAttribute("name", annotation)
994
ann_tag.setAttribute("value", value)
995
if_tag.appendChild(ann_tag)
996
727
# Add the names to the return values for the
997
728
# "org.freedesktop.DBus.Properties" methods
998
729
if (if_tag.getAttribute("name")
1013
744
except (AttributeError, xml.dom.DOMException,
1014
745
xml.parsers.expat.ExpatError) as error:
1015
746
logger.error("Failed to override Introspection method",
1016
exc_info=error)
747
error)
1017
748
return xmlstring
1018
749
1019
750
1020
def datetime_to_dbus(dt, variant_level=0):
751
def datetime_to_dbus (dt, variant_level=0):
1021
752
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1022
753
if dt is None:
1023
754
return dbus.String("", variant_level = variant_level)
1024
755
return dbus.String(dt.isoformat(),
1025
756
variant_level=variant_level)
1026
757
1027
1028
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1029
"""A class decorator; applied to a subclass of
1030
dbus.service.Object, it will add alternate D-Bus attributes with
1031
interface names according to the "alt_interface_names" mapping.
1032
Usage:
1033
1034
@alternate_dbus_interfaces({"org.example.Interface":
1035
"net.example.AlternateInterface"})
1036
class SampleDBusObject(dbus.service.Object):
1037
@dbus.service.method("org.example.Interface")
1038
def SampleDBusMethod():
1039
pass
1040
1041
The above "SampleDBusMethod" on "SampleDBusObject" will be
1042
reachable via two interfaces: "org.example.Interface" and
1043
"net.example.AlternateInterface", the latter of which will have
1044
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1045
"true", unless "deprecate" is passed with a False value.
1046
1047
This works for methods and signals, and also for D-Bus properties
1048
(from DBusObjectWithProperties) and interfaces (from the
1049
dbus_interface_annotations decorator).
1050
"""
1051
def wrapper(cls):
1052
for orig_interface_name, alt_interface_name in (
1053
alt_interface_names.iteritems()):
1054
attr = {}
1055
interface_names = set()
1056
# Go though all attributes of the class
1057
for attrname, attribute in inspect.getmembers(cls):
1058
# Ignore non-D-Bus attributes, and D-Bus attributes
1059
# with the wrong interface name
1060
if (not hasattr(attribute, "_dbus_interface")
1061
or not attribute._dbus_interface
1062
.startswith(orig_interface_name)):
1063
continue
1064
# Create an alternate D-Bus interface name based on
1065
# the current name
1066
alt_interface = (attribute._dbus_interface
1067
.replace(orig_interface_name,
1068
alt_interface_name))
1069
interface_names.add(alt_interface)
1070
# Is this a D-Bus signal?
1071
if getattr(attribute, "_dbus_is_signal", False):
1072
# Extract the original non-method function by
1073
# black magic
1074
nonmethod_func = (dict(
1075
zip(attribute.func_code.co_freevars,
1076
attribute.__closure__))["func"]
1077
.cell_contents)
1078
# Create a new, but exactly alike, function
1079
# object, and decorate it to be a new D-Bus signal
1080
# with the alternate D-Bus interface name
1081
new_function = (dbus.service.signal
1082
(alt_interface,
1083
attribute._dbus_signature)
1084
(types.FunctionType(
1085
nonmethod_func.func_code,
1086
nonmethod_func.func_globals,
1087
nonmethod_func.func_name,
1088
nonmethod_func.func_defaults,
1089
nonmethod_func.func_closure)))
1090
# Copy annotations, if any
1091
try:
1092
new_function._dbus_annotations = (
1093
dict(attribute._dbus_annotations))
1094
except AttributeError:
1095
pass
1096
# Define a creator of a function to call both the
1097
# original and alternate functions, so both the
1098
# original and alternate signals gets sent when
1099
# the function is called
1100
def fixscope(func1, func2):
1101
"""This function is a scope container to pass
1102
func1 and func2 to the "call_both" function
1103
outside of its arguments"""
1104
def call_both(*args, **kwargs):
1105
"""This function will emit two D-Bus
1106
signals by calling func1 and func2"""
1107
func1(*args, **kwargs)
1108
func2(*args, **kwargs)
1109
return call_both
1110
# Create the "call_both" function and add it to
1111
# the class
1112
attr[attrname] = fixscope(attribute, new_function)
1113
# Is this a D-Bus method?
1114
elif getattr(attribute, "_dbus_is_method", False):
1115
# Create a new, but exactly alike, function
1116
# object. Decorate it to be a new D-Bus method
1117
# with the alternate D-Bus interface name. Add it
1118
# to the class.
1119
attr[attrname] = (dbus.service.method
1120
(alt_interface,
1121
attribute._dbus_in_signature,
1122
attribute._dbus_out_signature)
1123
(types.FunctionType
1124
(attribute.func_code,
1125
attribute.func_globals,
1126
attribute.func_name,
1127
attribute.func_defaults,
1128
attribute.func_closure)))
1129
# Copy annotations, if any
1130
try:
1131
attr[attrname]._dbus_annotations = (
1132
dict(attribute._dbus_annotations))
1133
except AttributeError:
1134
pass
1135
# Is this a D-Bus property?
1136
elif getattr(attribute, "_dbus_is_property", False):
1137
# Create a new, but exactly alike, function
1138
# object, and decorate it to be a new D-Bus
1139
# property with the alternate D-Bus interface
1140
# name. Add it to the class.
1141
attr[attrname] = (dbus_service_property
1142
(alt_interface,
1143
attribute._dbus_signature,
1144
attribute._dbus_access,
1145
attribute
1146
._dbus_get_args_options
1147
["byte_arrays"])
1148
(types.FunctionType
1149
(attribute.func_code,
1150
attribute.func_globals,
1151
attribute.func_name,
1152
attribute.func_defaults,
1153
attribute.func_closure)))
1154
# Copy annotations, if any
1155
try:
1156
attr[attrname]._dbus_annotations = (
1157
dict(attribute._dbus_annotations))
1158
except AttributeError:
1159
pass
1160
# Is this a D-Bus interface?
1161
elif getattr(attribute, "_dbus_is_interface", False):
1162
# Create a new, but exactly alike, function
1163
# object. Decorate it to be a new D-Bus interface
1164
# with the alternate D-Bus interface name. Add it
1165
# to the class.
1166
attr[attrname] = (dbus_interface_annotations
1167
(alt_interface)
1168
(types.FunctionType
1169
(attribute.func_code,
1170
attribute.func_globals,
1171
attribute.func_name,
1172
attribute.func_defaults,
1173
attribute.func_closure)))
1174
if deprecate:
1175
# Deprecate all alternate interfaces
1176
iname="_AlternateDBusNames_interface_annotation{0}"
1177
for interface_name in interface_names:
1178
@dbus_interface_annotations(interface_name)
1179
def func(self):
1180
return { "org.freedesktop.DBus.Deprecated":
1181
"true" }
1182
# Find an unused name
1183
for aname in (iname.format(i)
1184
for i in itertools.count()):
1185
if aname not in attr:
1186
attr[aname] = func
1187
break
1188
if interface_names:
1189
# Replace the class with a new subclass of it with
1190
# methods, signals, etc. as created above.
1191
cls = type(b"{0}Alternate".format(cls.__name__),
1192
(cls,), attr)
1193
return cls
1194
return wrapper
1195
1196
1197
@alternate_dbus_interfaces({"se.recompile.Mandos":
1198
"se.bsnet.fukt.Mandos"})
758
class transitional_dbus_metaclass(DBusObjectWithProperties.__metaclass__):
759
def __new__(mcs, name, bases, attr):
760
for attrname, old_dbusobj in inspect.getmembers(bases[0]):
761
new_interface = getattr(old_dbusobj, "_dbus_interface", "").replace("se.bsnet.fukt.", "se.recompile.")
762
if (getattr(old_dbusobj, "_dbus_is_signal", False)
763
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
764
unwrappedfunc = dict(zip(old_dbusobj.func_code.co_freevars,
765
old_dbusobj.__closure__))["func"].cell_contents
766
newfunc = types.FunctionType(unwrappedfunc.func_code,
767
unwrappedfunc.func_globals,
768
unwrappedfunc.func_name,
769
unwrappedfunc.func_defaults,
770
unwrappedfunc.func_closure)
771
new_dbusfunc = dbus.service.signal(
772
new_interface, old_dbusobj._dbus_signature)(newfunc)
773
attr["_transitional_" + attrname] = new_dbusfunc
774
775
def fixscope(func1, func2):
776
def newcall(*args, **kwargs):
777
func1(*args, **kwargs)
778
func2(*args, **kwargs)
779
return newcall
780
781
attr[attrname] = fixscope(old_dbusobj, new_dbusfunc)
782
783
elif (getattr(old_dbusobj, "_dbus_is_method", False)
784
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
785
new_dbusfunc = (dbus.service.method
786
(new_interface,
787
old_dbusobj._dbus_in_signature,
788
old_dbusobj._dbus_out_signature)
789
(types.FunctionType
790
(old_dbusobj.func_code,
791
old_dbusobj.func_globals,
792
old_dbusobj.func_name,
793
old_dbusobj.func_defaults,
794
old_dbusobj.func_closure)))
795
796
attr[attrname] = new_dbusfunc
797
elif (getattr(old_dbusobj, "_dbus_is_property", False)
798
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
799
new_dbusfunc = (dbus_service_property
800
(new_interface,
801
old_dbusobj._dbus_signature,
802
old_dbusobj._dbus_access,
803
old_dbusobj._dbus_get_args_options["byte_arrays"])
804
(types.FunctionType
805
(old_dbusobj.func_code,
806
old_dbusobj.func_globals,
807
old_dbusobj.func_name,
808
old_dbusobj.func_defaults,
809
old_dbusobj.func_closure)))
810
811
attr[attrname] = new_dbusfunc
812
return type.__new__(mcs, name, bases, attr)
813
1199
814
class ClientDBus(Client, DBusObjectWithProperties):
1200
815
"""A Client class using D-Bus
1201
816
1210
825
# dbus.service.Object doesn't use super(), so we can't either.
1211
826
1212
827
def __init__(self, bus = None, *args, **kwargs):
828
self._approvals_pending = 0
1213
829
self.bus = bus
1214
830
Client.__init__(self, *args, **kwargs)
1215
831
# Only now, when this client is initialized, can it show up on
1221
837
("/clients/" + client_object_name))
1222
838
DBusObjectWithProperties.__init__(self, self.bus,
1223
839
self.dbus_object_path)
1224
840
1225
841
def notifychangeproperty(transform_func,
1226
842
dbus_name, type_func=lambda x: x,
1227
843
variant_level=1):
1228
""" Modify a variable so that it's a property which announces
1229
its changes to DBus.
1230
1231
transform_fun: Function that takes a value and a variant_level
1232
and transforms it to a D-Bus type.
1233
dbus_name: D-Bus name of the variable
844
""" Modify a variable so that its a property that announce its
845
changes to DBus.
846
transform_fun: Function that takes a value and transform it to
847
DBus type.
848
dbus_name: DBus name of the variable
1234
849
type_func: Function that transform the value before sending it
1235
to the D-Bus. Default: no transform
1236
variant_level: D-Bus variant level. Default: 1
850
to DBus
851
variant_level: DBus variant level. default: 1
1237
852
"""
1238
attrname = "_{0}".format(dbus_name)
853
real_value = [None,]
1239
854
def setter(self, value):
855
old_value = real_value[0]
856
real_value[0] = value
1240
857
if hasattr(self, "dbus_object_path"):
1241
if (not hasattr(self, attrname) or
1242
type_func(getattr(self, attrname, None))
1243
!= type_func(value)):
1244
dbus_value = transform_func(type_func(value),
1245
variant_level
1246
=variant_level)
858
if type_func(old_value) != type_func(real_value[0]):
859
dbus_value = transform_func(type_func(real_value[0]),
860
variant_level)
1247
861
self.PropertyChanged(dbus.String(dbus_name),
1248
862
dbus_value)
1249
setattr(self, attrname, value)
1250
863
1251
return property(lambda self: getattr(self, attrname), setter)
864
return property(lambda self: real_value[0], setter)
865
1252
866
1253
867
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1254
868
approvals_pending = notifychangeproperty(dbus.Boolean,
1258
872
last_enabled = notifychangeproperty(datetime_to_dbus,
1259
873
"LastEnabled")
1260
874
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1261
type_func = lambda checker:
1262
checker is not None)
875
type_func = lambda checker: checker is not None)
1263
876
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1264
877
"LastCheckedOK")
1265
last_checker_status = notifychangeproperty(dbus.Int16,
1266
"LastCheckerStatus")
1267
last_approval_request = notifychangeproperty(
1268
datetime_to_dbus, "LastApprovalRequest")
878
last_approval_request = notifychangeproperty(datetime_to_dbus,
879
"LastApprovalRequest")
1269
880
approved_by_default = notifychangeproperty(dbus.Boolean,
1270
881
"ApprovedByDefault")
1271
approval_delay = notifychangeproperty(dbus.UInt64,
1272
"ApprovalDelay",
1273
type_func =
1274
timedelta_to_milliseconds)
1275
approval_duration = notifychangeproperty(
1276
dbus.UInt64, "ApprovalDuration",
1277
type_func = timedelta_to_milliseconds)
882
approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
883
type_func = _timedelta_to_milliseconds)
884
approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
885
type_func = _timedelta_to_milliseconds)
1278
886
host = notifychangeproperty(dbus.String, "Host")
1279
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1280
type_func =
1281
timedelta_to_milliseconds)
1282
extended_timeout = notifychangeproperty(
1283
dbus.UInt64, "ExtendedTimeout",
1284
type_func = timedelta_to_milliseconds)
1285
interval = notifychangeproperty(dbus.UInt64,
1286
"Interval",
1287
type_func =
1288
timedelta_to_milliseconds)
887
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
888
type_func = _timedelta_to_milliseconds)
889
extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
890
type_func = _timedelta_to_milliseconds)
891
interval = notifychangeproperty(dbus.UInt16, "Interval",
892
type_func = _timedelta_to_milliseconds)
1289
893
checker_command = notifychangeproperty(dbus.String, "Checker")
1290
894
1291
895
del notifychangeproperty
1333
937
return r
1334
938
1335
939
def _reset_approved(self):
1336
self.approved = None
940
self._approved = None
1337
941
return False
1338
942
1339
943
def approve(self, value=True):
1340
self.approved = value
1341
gobject.timeout_add(timedelta_to_milliseconds
944
self.send_changedstate()
945
self._approved = value
946
gobject.timeout_add(_timedelta_to_milliseconds
1342
947
(self.approval_duration),
1343
948
self._reset_approved)
1344
self.send_changedstate()
949
1345
950
1346
951
## D-Bus methods, signals & properties
1347
_interface = "se.recompile.Mandos.Client"
1348
1349
## Interfaces
1350
1351
@dbus_interface_annotations(_interface)
1352
def _foo(self):
1353
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1354
"false"}
1355
952
_interface = "se.bsnet.fukt.Mandos.Client"
953
1356
954
## Signals
1357
955
1358
956
# CheckerCompleted - signal
1457
1055
access="readwrite")
1458
1056
def ApprovalDuration_dbus_property(self, value=None):
1459
1057
if value is None: # get
1460
return dbus.UInt64(timedelta_to_milliseconds(
1058
return dbus.UInt64(_timedelta_to_milliseconds(
1461
1059
self.approval_duration))
1462
1060
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1463
1061
1477
1075
def Host_dbus_property(self, value=None):
1478
1076
if value is None: # get
1479
1077
return dbus.String(self.host)
1480
self.host = unicode(value)
1078
self.host = value
1481
1079
1482
1080
# Created - property
1483
1081
@dbus_service_property(_interface, signature="s", access="read")
1484
1082
def Created_dbus_property(self):
1485
return datetime_to_dbus(self.created)
1083
return dbus.String(datetime_to_dbus(self.created))
1486
1084
1487
1085
# LastEnabled - property
1488
1086
@dbus_service_property(_interface, signature="s", access="read")
1509
1107
return
1510
1108
return datetime_to_dbus(self.last_checked_ok)
1511
1109
1512
# LastCheckerStatus - property
1513
@dbus_service_property(_interface, signature="n",
1514
access="read")
1515
def LastCheckerStatus_dbus_property(self):
1516
return dbus.Int16(self.last_checker_status)
1517
1518
1110
# Expires - property
1519
1111
@dbus_service_property(_interface, signature="s", access="read")
1520
1112
def Expires_dbus_property(self):
1531
1123
def Timeout_dbus_property(self, value=None):
1532
1124
if value is None: # get
1533
1125
return dbus.UInt64(self.timeout_milliseconds())
1534
old_timeout = self.timeout
1535
1126
self.timeout = datetime.timedelta(0, 0, 0, value)
1536
# Reschedule disabling
1537
if self.enabled:
1538
now = datetime.datetime.utcnow()
1539
self.expires += self.timeout - old_timeout
1540
if self.expires <= now:
1541
# The timeout has passed
1542
self.disable()
1543
else:
1544
if (getattr(self, "disable_initiator_tag", None)
1545
is None):
1546
return
1547
gobject.source_remove(self.disable_initiator_tag)
1548
self.disable_initiator_tag = (
1549
gobject.timeout_add(
1550
timedelta_to_milliseconds(self.expires - now),
1551
self.disable))
1127
if getattr(self, "disable_initiator_tag", None) is None:
1128
return
1129
# Reschedule timeout
1130
gobject.source_remove(self.disable_initiator_tag)
1131
self.disable_initiator_tag = None
1132
self.expires = None
1133
time_to_die = (self.
1134
_timedelta_to_milliseconds((self
1135
.last_checked_ok
1136
+ self.timeout)
1137
- datetime.datetime
1138
.utcnow()))
1139
if time_to_die <= 0:
1140
# The timeout has passed
1141
self.disable()
1142
else:
1143
self.expires = (datetime.datetime.utcnow()
1144
+ datetime.timedelta(milliseconds = time_to_die))
1145
self.disable_initiator_tag = (gobject.timeout_add
1146
(time_to_die, self.disable))
1552
1147
1553
1148
# ExtendedTimeout - property
1554
1149
@dbus_service_property(_interface, signature="t",
1567
1162
self.interval = datetime.timedelta(0, 0, 0, value)
1568
1163
if getattr(self, "checker_initiator_tag", None) is None:
1569
1164
return
1570
if self.enabled:
1571
# Reschedule checker run
1572
gobject.source_remove(self.checker_initiator_tag)
1573
self.checker_initiator_tag = (gobject.timeout_add
1574
(value, self.start_checker))
1575
self.start_checker() # Start one now, too
1165
# Reschedule checker run
1166
gobject.source_remove(self.checker_initiator_tag)
1167
self.checker_initiator_tag = (gobject.timeout_add
1168
(value, self.start_checker))
1169
self.start_checker() # Start one now, too
1576
1170
1577
1171
# Checker - property
1578
1172
@dbus_service_property(_interface, signature="s",
1580
1174
def Checker_dbus_property(self, value=None):
1581
1175
if value is None: # get
1582
1176
return dbus.String(self.checker_command)
1583
self.checker_command = unicode(value)
1177
self.checker_command = value
1584
1178
1585
1179
# CheckerRunning - property
1586
1180
@dbus_service_property(_interface, signature="b",
1615
1209
raise KeyError()
1616
1210
1617
1211
def __getattribute__(self, name):
1618
if name == '_pipe':
1212
if(name == '_pipe'):
1619
1213
return super(ProxyClient, self).__getattribute__(name)
1620
1214
self._pipe.send(('getattr', name))
1621
1215
data = self._pipe.recv()
1628
1222
return func
1629
1223
1630
1224
def __setattr__(self, name, value):
1631
if name == '_pipe':
1225
if(name == '_pipe'):
1632
1226
return super(ProxyClient, self).__setattr__(name, value)
1633
1227
self._pipe.send(('setattr', name, value))
1634
1228
1229
class ClientDBusTransitional(ClientDBus):
1230
__metaclass__ = transitional_dbus_metaclass
1635
1231
1636
1232
class ClientHandler(socketserver.BaseRequestHandler, object):
1637
1233
"""A class to handle client connections.
1717
1313
client.name)
1718
1314
if self.server.use_dbus:
1719
1315
# Emit D-Bus signal
1720
client.Rejected("Disabled")
1316
client.Rejected("Disabled")
1721
1317
return
1722
1318
1723
if client.approved or not client.approval_delay:
1319
if client._approved or not client.approval_delay:
1724
1320
#We are approved or approval is disabled
1725
1321
break
1726
elif client.approved is None:
1322
elif client._approved is None:
1727
1323
logger.info("Client %s needs approval",
1728
1324
client.name)
1729
1325
if self.server.use_dbus:
1740
1336
return
1741
1337
1742
1338
#wait until timeout or approved
1339
#x = float(client._timedelta_to_milliseconds(delay))
1743
1340
time = datetime.datetime.now()
1744
1341
client.changedstate.acquire()
1745
client.changedstate.wait(
1746
float(timedelta_to_milliseconds(delay)
1747
/ 1000))
1342
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1748
1343
client.changedstate.release()
1749
1344
time2 = datetime.datetime.now()
1750
1345
if (time2 - time) >= delay:
1766
1361
try:
1767
1362
sent = session.send(client.secret[sent_size:])
1768
1363
except gnutls.errors.GNUTLSError as error:
1769
logger.warning("gnutls send failed",
1770
exc_info=error)
1364
logger.warning("gnutls send failed")
1771
1365
return
1772
1366
logger.debug("Sent: %d, remaining: %d",
1773
1367
sent, len(client.secret)
1775
1369
sent_size += sent
1776
1370
1777
1371
logger.info("Sending secret to %s", client.name)
1778
# bump the timeout using extended_timeout
1779
client.bump_timeout(client.extended_timeout)
1372
# bump the timeout as if seen
1373
client.checked_ok(client.extended_timeout)
1780
1374
if self.server.use_dbus:
1781
1375
# Emit D-Bus signal
1782
1376
client.GotSecret()
1787
1381
try:
1788
1382
session.bye()
1789
1383
except gnutls.errors.GNUTLSError as error:
1790
logger.warning("GnuTLS bye failed",
1791
exc_info=error)
1384
logger.warning("GnuTLS bye failed")
1792
1385
1793
1386
@staticmethod
1794
1387
def peer_certificate(session):
1850
1443
# Convert the buffer to a Python bytestring
1851
1444
fpr = ctypes.string_at(buf, buf_len.value)
1852
1445
# Convert the bytestring to hexadecimal notation
1853
hex_fpr = binascii.hexlify(fpr).upper()
1446
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1854
1447
return hex_fpr
1855
1448
1856
1449
1859
1452
def sub_process_main(self, request, address):
1860
1453
try:
1861
1454
self.finish_request(request, address)
1862
except Exception:
1455
except:
1863
1456
self.handle_error(request, address)
1864
1457
self.close_request(request)
1865
1458
1866
1459
def process_request(self, request, address):
1867
1460
"""Start a new process to process the request."""
1868
proc = multiprocessing.Process(target = self.sub_process_main,
1869
args = (request, address))
1870
proc.start()
1871
return proc
1461
multiprocessing.Process(target = self.sub_process_main,
1462
args = (request, address)).start()
1872
1463
1873
1464
1874
1465
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1880
1471
"""
1881
1472
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1882
1473
1883
proc = MultiprocessingMixIn.process_request(self, request,
1884
client_address)
1474
super(MultiprocessingMixInWithPipe,
1475
self).process_request(request, client_address)
1885
1476
self.child_pipe.close()
1886
self.add_pipe(parent_pipe, proc)
1477
self.add_pipe(parent_pipe)
1887
1478
1888
def add_pipe(self, parent_pipe, proc):
1479
def add_pipe(self, parent_pipe):
1889
1480
"""Dummy function; override as necessary"""
1890
1481
raise NotImplementedError
1891
1482
1900
1491
use_ipv6: Boolean; to use IPv6 or not
1901
1492
"""
1902
1493
def __init__(self, server_address, RequestHandlerClass,
1903
interface=None, use_ipv6=True, socketfd=None):
1904
"""If socketfd is set, use that file descriptor instead of
1905
creating a new one with socket.socket().
1906
"""
1494
interface=None, use_ipv6=True):
1907
1495
self.interface = interface
1908
1496
if use_ipv6:
1909
1497
self.address_family = socket.AF_INET6
1910
if socketfd is not None:
1911
# Save the file descriptor
1912
self.socketfd = socketfd
1913
# Save the original socket.socket() function
1914
self.socket_socket = socket.socket
1915
# To implement --socket, we monkey patch socket.socket.
1916
#
1917
# (When socketserver.TCPServer is a new-style class, we
1918
# could make self.socket into a property instead of monkey
1919
# patching socket.socket.)
1920
#
1921
# Create a one-time-only replacement for socket.socket()
1922
@functools.wraps(socket.socket)
1923
def socket_wrapper(*args, **kwargs):
1924
# Restore original function so subsequent calls are
1925
# not affected.
1926
socket.socket = self.socket_socket
1927
del self.socket_socket
1928
# This time only, return a new socket object from the
1929
# saved file descriptor.
1930
return socket.fromfd(self.socketfd, *args, **kwargs)
1931
# Replace socket.socket() function with wrapper
1932
socket.socket = socket_wrapper
1933
# The socketserver.TCPServer.__init__ will call
1934
# socket.socket(), which might be our replacement,
1935
# socket_wrapper(), if socketfd was set.
1936
1498
socketserver.TCPServer.__init__(self, server_address,
1937
1499
RequestHandlerClass)
1938
1939
1500
def server_bind(self):
1940
1501
"""This overrides the normal server_bind() function
1941
1502
to bind to an interface if one was specified, and also NOT to
1949
1510
try:
1950
1511
self.socket.setsockopt(socket.SOL_SOCKET,
1951
1512
SO_BINDTODEVICE,
1952
str(self.interface + '\0'))
1513
str(self.interface
1514
+ '\0'))
1953
1515
except socket.error as error:
1954
if error.errno == errno.EPERM:
1955
logger.error("No permission to bind to"
1956
" interface %s", self.interface)
1957
elif error.errno == errno.ENOPROTOOPT:
1516
if error[0] == errno.EPERM:
1517
logger.error("No permission to"
1518
" bind to interface %s",
1519
self.interface)
1520
elif error[0] == errno.ENOPROTOOPT:
1958
1521
logger.error("SO_BINDTODEVICE not available;"
1959
1522
" cannot bind to interface %s",
1960
1523
self.interface)
1961
elif error.errno == errno.ENODEV:
1962
logger.error("Interface %s does not exist,"
1963
" cannot bind", self.interface)
1964
1524
else:
1965
1525
raise
1966
1526
# Only bind(2) the socket if we really need to.
1996
1556
"""
1997
1557
def __init__(self, server_address, RequestHandlerClass,
1998
1558
interface=None, use_ipv6=True, clients=None,
1999
gnutls_priority=None, use_dbus=True, socketfd=None):
1559
gnutls_priority=None, use_dbus=True):
2000
1560
self.enabled = False
2001
1561
self.clients = clients
2002
1562
if self.clients is None:
2003
self.clients = {}
1563
self.clients = set()
2004
1564
self.use_dbus = use_dbus
2005
1565
self.gnutls_priority = gnutls_priority
2006
1566
IPv6_TCPServer.__init__(self, server_address,
2007
1567
RequestHandlerClass,
2008
1568
interface = interface,
2009
use_ipv6 = use_ipv6,
2010
socketfd = socketfd)
1569
use_ipv6 = use_ipv6)
2011
1570
def server_activate(self):
2012
1571
if self.enabled:
2013
1572
return socketserver.TCPServer.server_activate(self)
2014
2015
1573
def enable(self):
2016
1574
self.enabled = True
2017
2018
def add_pipe(self, parent_pipe, proc):
1575
def add_pipe(self, parent_pipe):
2019
1576
# Call "handle_ipc" for both data and EOF events
2020
1577
gobject.io_add_watch(parent_pipe.fileno(),
2021
1578
gobject.IO_IN | gobject.IO_HUP,
2022
1579
functools.partial(self.handle_ipc,
2023
parent_pipe =
2024
parent_pipe,
2025
proc = proc))
2026
1580
parent_pipe = parent_pipe))
1581
2027
1582
def handle_ipc(self, source, condition, parent_pipe=None,
2028
proc = None, client_object=None):
2029
# error, or the other end of multiprocessing.Pipe has closed
2030
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2031
# Wait for other process to exit
2032
proc.join()
1583
client_object=None):
1584
condition_names = {
1585
gobject.IO_IN: "IN", # There is data to read.
1586
gobject.IO_OUT: "OUT", # Data can be written (without
1587
# blocking).
1588
gobject.IO_PRI: "PRI", # There is urgent data to read.
1589
gobject.IO_ERR: "ERR", # Error condition.
1590
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1591
# broken, usually for pipes and
1592
# sockets).
1593
}
1594
conditions_string = ' | '.join(name
1595
for cond, name in
1596
condition_names.iteritems()
1597
if cond & condition)
1598
# error or the other end of multiprocessing.Pipe has closed
1599
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2033
1600
return False
2034
1601
2035
1602
# Read a request from the child
2040
1607
fpr = request[1]
2041
1608
address = request[2]
2042
1609
2043
for c in self.clients.itervalues():
1610
for c in self.clients:
2044
1611
if c.fingerprint == fpr:
2045
1612
client = c
2046
1613
break
2049
1616
"dress: %s", fpr, address)
2050
1617
if self.use_dbus:
2051
1618
# Emit D-Bus signal
2052
mandos_dbus_service.ClientNotFound(fpr,
2053
address[0])
1619
mandos_dbus_service.ClientNotFound(fpr, address[0])
2054
1620
parent_pipe.send(False)
2055
1621
return False
2056
1622
2057
1623
gobject.io_add_watch(parent_pipe.fileno(),
2058
1624
gobject.IO_IN | gobject.IO_HUP,
2059
1625
functools.partial(self.handle_ipc,
2060
parent_pipe =
2061
parent_pipe,
2062
proc = proc,
2063
client_object =
2064
client))
1626
parent_pipe = parent_pipe,
1627
client_object = client))
2065
1628
parent_pipe.send(True)
2066
# remove the old hook in favor of the new above hook on
2067
# same fileno
1629
# remove the old hook in favor of the new above hook on same fileno
2068
1630
return False
2069
1631
if command == 'funcall':
2070
1632
funcname = request[1]
2071
1633
args = request[2]
2072
1634
kwargs = request[3]
2073
1635
2074
parent_pipe.send(('data', getattr(client_object,
2075
funcname)(*args,
2076
**kwargs)))
1636
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2077
1637
2078
1638
if command == 'getattr':
2079
1639
attrname = request[1]
2080
1640
if callable(client_object.__getattribute__(attrname)):
2081
1641
parent_pipe.send(('function',))
2082
1642
else:
2083
parent_pipe.send(('data', client_object
2084
.__getattribute__(attrname)))
1643
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2085
1644
2086
1645
if command == 'setattr':
2087
1646
attrname = request[1]
2091
1650
return True
2092
1651
2093
1652
2094
def rfc3339_duration_to_delta(duration):
2095
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2096
2097
>>> rfc3339_duration_to_delta("P7D")
2098
datetime.timedelta(7)
2099
>>> rfc3339_duration_to_delta("PT60S")
2100
datetime.timedelta(0, 60)
2101
>>> rfc3339_duration_to_delta("PT60M")
2102
datetime.timedelta(0, 3600)
2103
>>> rfc3339_duration_to_delta("PT24H")
2104
datetime.timedelta(1)
2105
>>> rfc3339_duration_to_delta("P1W")
2106
datetime.timedelta(7)
2107
>>> rfc3339_duration_to_delta("PT5M30S")
2108
datetime.timedelta(0, 330)
2109
>>> rfc3339_duration_to_delta("P1DT3M20S")
2110
datetime.timedelta(1, 200)
2111
"""
2112
2113
# Parsing an RFC 3339 duration with regular expressions is not
2114
# possible - there would have to be multiple places for the same
2115
# values, like seconds. The current code, while more esoteric, is
2116
# cleaner without depending on a parsing library. If Python had a
2117
# built-in library for parsing we would use it, but we'd like to
2118
# avoid excessive use of external libraries.
2119
2120
# New type for defining tokens, syntax, and semantics all-in-one
2121
Token = collections.namedtuple("Token",
2122
("regexp", # To match token; if
2123
# "value" is not None,
2124
# must have a "group"
2125
# containing digits
2126
"value", # datetime.timedelta or
2127
# None
2128
"followers")) # Tokens valid after
2129
# this token
2130
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2131
# the "duration" ABNF definition in RFC 3339, Appendix A.
2132
token_end = Token(re.compile(r"$"), None, frozenset())
2133
token_second = Token(re.compile(r"(\d+)S"),
2134
datetime.timedelta(seconds=1),
2135
frozenset((token_end,)))
2136
token_minute = Token(re.compile(r"(\d+)M"),
2137
datetime.timedelta(minutes=1),
2138
frozenset((token_second, token_end)))
2139
token_hour = Token(re.compile(r"(\d+)H"),
2140
datetime.timedelta(hours=1),
2141
frozenset((token_minute, token_end)))
2142
token_time = Token(re.compile(r"T"),
2143
None,
2144
frozenset((token_hour, token_minute,
2145
token_second)))
2146
token_day = Token(re.compile(r"(\d+)D"),
2147
datetime.timedelta(days=1),
2148
frozenset((token_time, token_end)))
2149
token_month = Token(re.compile(r"(\d+)M"),
2150
datetime.timedelta(weeks=4),
2151
frozenset((token_day, token_end)))
2152
token_year = Token(re.compile(r"(\d+)Y"),
2153
datetime.timedelta(weeks=52),
2154
frozenset((token_month, token_end)))
2155
token_week = Token(re.compile(r"(\d+)W"),
2156
datetime.timedelta(weeks=1),
2157
frozenset((token_end,)))
2158
token_duration = Token(re.compile(r"P"), None,
2159
frozenset((token_year, token_month,
2160
token_day, token_time,
2161
token_week))),
2162
# Define starting values
2163
value = datetime.timedelta() # Value so far
2164
found_token = None
2165
followers = frozenset(token_duration,) # Following valid tokens
2166
s = duration # String left to parse
2167
# Loop until end token is found
2168
while found_token is not token_end:
2169
# Search for any currently valid tokens
2170
for token in followers:
2171
match = token.regexp.match(s)
2172
if match is not None:
2173
# Token found
2174
if token.value is not None:
2175
# Value found, parse digits
2176
factor = int(match.group(1), 10)
2177
# Add to value so far
2178
value += factor * token.value
2179
# Strip token from string
2180
s = token.regexp.sub("", s, 1)
2181
# Go to found token
2182
found_token = token
2183
# Set valid next tokens
2184
followers = found_token.followers
2185
break
2186
else:
2187
# No currently valid tokens were found
2188
raise ValueError("Invalid RFC 3339 duration")
2189
# End token found
2190
return value
2191
2192
2193
1653
def string_to_delta(interval):
2194
1654
"""Parse a string and return a datetime.timedelta
2195
1655
2206
1666
>>> string_to_delta('5m 30s')
2207
1667
datetime.timedelta(0, 330)
2208
1668
"""
2209
2210
try:
2211
return rfc3339_duration_to_delta(interval)
2212
except ValueError:
2213
pass
2214
2215
1669
timevalue = datetime.timedelta(0)
2216
1670
for s in interval.split():
2217
1671
try:
2228
1682
elif suffix == "w":
2229
1683
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2230
1684
else:
2231
raise ValueError("Unknown suffix {0!r}"
2232
.format(suffix))
1685
raise ValueError("Unknown suffix %r" % suffix)
2233
1686
except (ValueError, IndexError) as e:
2234
1687
raise ValueError(*(e.args))
2235
1688
timevalue += delta
2236
1689
return timevalue
2237
1690
2238
1691
1692
def if_nametoindex(interface):
1693
"""Call the C function if_nametoindex(), or equivalent
1694
1695
Note: This function cannot accept a unicode string."""
1696
global if_nametoindex
1697
try:
1698
if_nametoindex = (ctypes.cdll.LoadLibrary
1699
(ctypes.util.find_library("c"))
1700
.if_nametoindex)
1701
except (OSError, AttributeError):
1702
logger.warning("Doing if_nametoindex the hard way")
1703
def if_nametoindex(interface):
1704
"Get an interface index the hard way, i.e. using fcntl()"
1705
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1706
with contextlib.closing(socket.socket()) as s:
1707
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1708
struct.pack(str("16s16x"),
1709
interface))
1710
interface_index = struct.unpack(str("I"),
1711
ifreq[16:20])[0]
1712
return interface_index
1713
return if_nametoindex(interface)
1714
1715
2239
1716
def daemon(nochdir = False, noclose = False):
2240
1717
"""See daemon(3). Standard BSD Unix function.
2241
1718
2249
1726
sys.exit()
2250
1727
if not noclose:
2251
1728
# Close all standard open file descriptors
2252
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1729
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2253
1730
if not stat.S_ISCHR(os.fstat(null).st_mode):
2254
1731
raise OSError(errno.ENODEV,
2255
"{0} not a character device"
2256
.format(os.devnull))
1732
"%s not a character device"
1733
% os.path.devnull)
2257
1734
os.dup2(null, sys.stdin.fileno())
2258
1735
os.dup2(null, sys.stdout.fileno())
2259
1736
os.dup2(null, sys.stderr.fileno())
2268
1745
2269
1746
parser = argparse.ArgumentParser()
2270
1747
parser.add_argument("-v", "--version", action="version",
2271
version = "%(prog)s {0}".format(version),
1748
version = "%%(prog)s %s" % version,
2272
1749
help="show version number and exit")
2273
1750
parser.add_argument("-i", "--interface", metavar="IF",
2274
1751
help="Bind to interface IF")
2296
1773
" system bus interface")
2297
1774
parser.add_argument("--no-ipv6", action="store_false",
2298
1775
dest="use_ipv6", help="Do not use IPv6")
2299
parser.add_argument("--no-restore", action="store_false",
2300
dest="restore", help="Do not restore stored"
2301
" state")
2302
parser.add_argument("--socket", type=int,
2303
help="Specify a file descriptor to a network"
2304
" socket to use instead of creating one")
2305
parser.add_argument("--statedir", metavar="DIR",
2306
help="Directory to save/restore state in")
2307
parser.add_argument("--foreground", action="store_true",
2308
help="Run in foreground")
2309
2310
1776
options = parser.parse_args()
2311
1777
2312
1778
if options.check:
2325
1791
"use_dbus": "True",
2326
1792
"use_ipv6": "True",
2327
1793
"debuglevel": "",
2328
"restore": "True",
2329
"socket": "",
2330
"statedir": "/var/lib/mandos",
2331
"foreground": "False",
2332
1794
}
2333
1795
2334
1796
# Parse config file for server-global settings
2339
1801
# Convert the SafeConfigParser object to a dict
2340
1802
server_settings = server_config.defaults()
2341
1803
# Use the appropriate methods on the non-string config options
2342
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1804
for option in ("debug", "use_dbus", "use_ipv6"):
2343
1805
server_settings[option] = server_config.getboolean("DEFAULT",
2344
1806
option)
2345
1807
if server_settings["port"]:
2346
1808
server_settings["port"] = server_config.getint("DEFAULT",
2347
1809
"port")
2348
if server_settings["socket"]:
2349
server_settings["socket"] = server_config.getint("DEFAULT",
2350
"socket")
2351
# Later, stdin will, and stdout and stderr might, be dup'ed
2352
# over with an opened os.devnull. But we don't want this to
2353
# happen with a supplied network socket.
2354
if 0 <= server_settings["socket"] <= 2:
2355
server_settings["socket"] = os.dup(server_settings
2356
["socket"])
2357
1810
del server_config
2358
1811
2359
1812
# Override the settings from the config file with command line
2360
1813
# options, if set.
2361
1814
for option in ("interface", "address", "port", "debug",
2362
1815
"priority", "servicename", "configdir",
2363
"use_dbus", "use_ipv6", "debuglevel", "restore",
2364
"statedir", "socket", "foreground"):
1816
"use_dbus", "use_ipv6", "debuglevel"):
2365
1817
value = getattr(options, option)
2366
1818
if value is not None:
2367
1819
server_settings[option] = value
2370
1822
for option in server_settings.keys():
2371
1823
if type(server_settings[option]) is str:
2372
1824
server_settings[option] = unicode(server_settings[option])
2373
# Debug implies foreground
2374
if server_settings["debug"]:
2375
server_settings["foreground"] = True
2376
1825
# Now we have our good server settings in "server_settings"
2377
1826
2378
1827
##################################################################
2382
1831
debuglevel = server_settings["debuglevel"]
2383
1832
use_dbus = server_settings["use_dbus"]
2384
1833
use_ipv6 = server_settings["use_ipv6"]
2385
stored_state_path = os.path.join(server_settings["statedir"],
2386
stored_state_file)
2387
foreground = server_settings["foreground"]
2388
2389
if debug:
2390
initlogger(debug, logging.DEBUG)
2391
else:
2392
if not debuglevel:
2393
initlogger(debug)
2394
else:
2395
level = getattr(logging, debuglevel.upper())
2396
initlogger(debug, level)
2397
1834
2398
1835
if server_settings["servicename"] != "Mandos":
2399
1836
syslogger.setFormatter(logging.Formatter
2400
('Mandos ({0}) [%(process)d]:'
2401
' %(levelname)s: %(message)s'
2402
.format(server_settings
2403
["servicename"])))
1837
('Mandos (%s) [%%(process)d]:'
1838
' %%(levelname)s: %%(message)s'
1839
% server_settings["servicename"]))
2404
1840
2405
1841
# Parse config file with clients
2406
client_config = configparser.SafeConfigParser(Client
2407
.client_defaults)
1842
client_defaults = { "timeout": "5m",
1843
"extended_timeout": "15m",
1844
"interval": "2m",
1845
"checker": "fping -q -- %%(host)s",
1846
"host": "",
1847
"approval_delay": "0s",
1848
"approval_duration": "1s",
1849
}
1850
client_config = configparser.SafeConfigParser(client_defaults)
2408
1851
client_config.read(os.path.join(server_settings["configdir"],
2409
1852
"clients.conf"))
2410
1853
2419
1862
use_ipv6=use_ipv6,
2420
1863
gnutls_priority=
2421
1864
server_settings["priority"],
2422
use_dbus=use_dbus,
2423
socketfd=(server_settings["socket"]
2424
or None))
2425
if not foreground:
1865
use_dbus=use_dbus)
1866
if not debug:
2426
1867
pidfilename = "/var/run/mandos.pid"
2427
pidfile = None
2428
1868
try:
2429
1869
pidfile = open(pidfilename, "w")
2430
except IOError as e:
2431
logger.error("Could not open file %r", pidfilename,
2432
exc_info=e)
1870
except IOError:
1871
logger.error("Could not open file %r", pidfilename)
2433
1872
2434
for name in ("_mandos", "mandos", "nobody"):
1873
try:
1874
uid = pwd.getpwnam("_mandos").pw_uid
1875
gid = pwd.getpwnam("_mandos").pw_gid
1876
except KeyError:
2435
1877
try:
2436
uid = pwd.getpwnam(name).pw_uid
2437
gid = pwd.getpwnam(name).pw_gid
2438
break
1878
uid = pwd.getpwnam("mandos").pw_uid
1879
gid = pwd.getpwnam("mandos").pw_gid
2439
1880
except KeyError:
2440
continue
2441
else:
2442
uid = 65534
2443
gid = 65534
1881
try:
1882
uid = pwd.getpwnam("nobody").pw_uid
1883
gid = pwd.getpwnam("nobody").pw_gid
1884
except KeyError:
1885
uid = 65534
1886
gid = 65534
2444
1887
try:
2445
1888
os.setgid(gid)
2446
1889
os.setuid(uid)
2447
1890
except OSError as error:
2448
if error.errno != errno.EPERM:
1891
if error[0] != errno.EPERM:
2449
1892
raise error
2450
1893
1894
if not debug and not debuglevel:
1895
syslogger.setLevel(logging.WARNING)
1896
console.setLevel(logging.WARNING)
1897
if debuglevel:
1898
level = getattr(logging, debuglevel.upper())
1899
syslogger.setLevel(level)
1900
console.setLevel(level)
1901
2451
1902
if debug:
2452
1903
# Enable all possible GnuTLS debugging
2453
1904
2463
1914
.gnutls_global_set_log_function(debug_gnutls))
2464
1915
2465
1916
# Redirect stdin so all checkers get /dev/null
2466
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1917
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2467
1918
os.dup2(null, sys.stdin.fileno())
2468
1919
if null > 2:
2469
1920
os.close(null)
1921
else:
1922
# No console logging
1923
logger.removeHandler(console)
2470
1924
2471
1925
# Need to fork before connecting to D-Bus
2472
if not foreground:
1926
if not debug:
2473
1927
# Close all input and output, do double fork, etc.
2474
1928
daemon()
2475
1929
2476
# multiprocessing will use threads, so before we use gobject we
2477
# need to inform gobject that threads will be used.
2478
gobject.threads_init()
2479
2480
1930
global main_loop
2481
1931
# From the Avahi example code
2482
DBusGMainLoop(set_as_default=True)
1932
DBusGMainLoop(set_as_default=True )
2483
1933
main_loop = gobject.MainLoop()
2484
1934
bus = dbus.SystemBus()
2485
1935
# End of Avahi example code
2486
1936
if use_dbus:
2487
1937
try:
2488
bus_name = dbus.service.BusName("se.recompile.Mandos",
2489
bus, do_not_queue=True)
2490
old_bus_name = (dbus.service.BusName
2491
("se.bsnet.fukt.Mandos", bus,
2492
do_not_queue=True))
1938
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1939
bus, do_not_queue=True)
1940
bus_name2 = dbus.service.BusName("se.recompile.Mandos",
1941
bus, do_not_queue=True)
2493
1942
except dbus.exceptions.NameExistsException as e:
2494
logger.error("Disabling D-Bus:", exc_info=e)
1943
logger.error(unicode(e) + ", disabling D-Bus")
2495
1944
use_dbus = False
2496
1945
server_settings["use_dbus"] = False
2497
1946
tcp_server.use_dbus = False
2498
1947
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2499
service = AvahiServiceToSyslog(name =
2500
server_settings["servicename"],
2501
servicetype = "_mandos._tcp",
2502
protocol = protocol, bus = bus)
1948
service = AvahiService(name = server_settings["servicename"],
1949
servicetype = "_mandos._tcp",
1950
protocol = protocol, bus = bus)
2503
1951
if server_settings["interface"]:
2504
1952
service.interface = (if_nametoindex
2505
1953
(str(server_settings["interface"])))
2509
1957
2510
1958
client_class = Client
2511
1959
if use_dbus:
2512
client_class = functools.partial(ClientDBus, bus = bus)
2513
2514
client_settings = Client.config_parser(client_config)
2515
old_client_settings = {}
2516
clients_data = {}
2517
2518
# Get client data and settings from last running state.
2519
if server_settings["restore"]:
2520
try:
2521
with open(stored_state_path, "rb") as stored_state:
2522
clients_data, old_client_settings = (pickle.load
2523
(stored_state))
2524
os.remove(stored_state_path)
2525
except IOError as e:
2526
if e.errno == errno.ENOENT:
2527
logger.warning("Could not load persistent state: {0}"
2528
.format(os.strerror(e.errno)))
2529
else:
2530
logger.critical("Could not load persistent state:",
2531
exc_info=e)
2532
raise
2533
except EOFError as e:
2534
logger.warning("Could not load persistent state: "
2535
"EOFError:", exc_info=e)
2536
2537
with PGPEngine() as pgp:
2538
for client_name, client in clients_data.iteritems():
2539
# Decide which value to use after restoring saved state.
2540
# We have three different values: Old config file,
2541
# new config file, and saved state.
2542
# New config value takes precedence if it differs from old
2543
# config value, otherwise use saved state.
2544
for name, value in client_settings[client_name].items():
2545
try:
2546
# For each value in new config, check if it
2547
# differs from the old config value (Except for
2548
# the "secret" attribute)
2549
if (name != "secret" and
2550
value != old_client_settings[client_name]
2551
[name]):
2552
client[name] = value
2553
except KeyError:
2554
pass
2555
2556
# Clients who has passed its expire date can still be
2557
# enabled if its last checker was successful. Clients
2558
# whose checker succeeded before we stored its state is
2559
# assumed to have successfully run all checkers during
2560
# downtime.
2561
if client["enabled"]:
2562
if datetime.datetime.utcnow() >= client["expires"]:
2563
if not client["last_checked_ok"]:
2564
logger.warning(
2565
"disabling client {0} - Client never "
2566
"performed a successful checker"
2567
.format(client_name))
2568
client["enabled"] = False
2569
elif client["last_checker_status"] != 0:
2570
logger.warning(
2571
"disabling client {0} - Client "
2572
"last checker failed with error code {1}"
2573
.format(client_name,
2574
client["last_checker_status"]))
2575
client["enabled"] = False
2576
else:
2577
client["expires"] = (datetime.datetime
2578
.utcnow()
2579
+ client["timeout"])
2580
logger.debug("Last checker succeeded,"
2581
" keeping {0} enabled"
2582
.format(client_name))
1960
client_class = functools.partial(ClientDBusTransitional, bus = bus)
1961
def client_config_items(config, section):
1962
special_settings = {
1963
"approved_by_default":
1964
lambda: config.getboolean(section,
1965
"approved_by_default"),
1966
}
1967
for name, value in config.items(section):
2583
1968
try:
2584
client["secret"] = (
2585
pgp.decrypt(client["encrypted_secret"],
2586
client_settings[client_name]
2587
["secret"]))
2588
except PGPError:
2589
# If decryption fails, we use secret from new settings
2590
logger.debug("Failed to decrypt {0} old secret"
2591
.format(client_name))
2592
client["secret"] = (
2593
client_settings[client_name]["secret"])
2594
2595
# Add/remove clients based on new changes made to config
2596
for client_name in (set(old_client_settings)
2597
- set(client_settings)):
2598
del clients_data[client_name]
2599
for client_name in (set(client_settings)
2600
- set(old_client_settings)):
2601
clients_data[client_name] = client_settings[client_name]
2602
2603
# Create all client objects
2604
for client_name, client in clients_data.iteritems():
2605
tcp_server.clients[client_name] = client_class(
2606
name = client_name, settings = client)
2607
1969
yield (name, special_settings[name]())
1970
except KeyError:
1971
yield (name, value)
1972
1973
tcp_server.clients.update(set(
1974
client_class(name = section,
1975
config= dict(client_config_items(
1976
client_config, section)))
1977
for section in client_config.sections()))
2608
1978
if not tcp_server.clients:
2609
1979
logger.warning("No clients defined")
2610
2611
if not foreground:
2612
if pidfile is not None:
2613
try:
2614
with pidfile:
2615
pid = os.getpid()
2616
pidfile.write(str(pid) + "\n".encode("utf-8"))
2617
except IOError:
2618
logger.error("Could not write to file %r with PID %d",
2619
pidfilename, pid)
2620
del pidfile
1980
1981
if not debug:
1982
try:
1983
with pidfile:
1984
pid = os.getpid()
1985
pidfile.write(str(pid) + "\n".encode("utf-8"))
1986
del pidfile
1987
except IOError:
1988
logger.error("Could not write to file %r with PID %d",
1989
pidfilename, pid)
1990
except NameError:
1991
# "pidfile" was never created
1992
pass
2621
1993
del pidfilename
1994
1995
signal.signal(signal.SIGINT, signal.SIG_IGN)
2622
1996
2623
1997
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2624
1998
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2625
1999
2626
2000
if use_dbus:
2627
@alternate_dbus_interfaces({"se.recompile.Mandos":
2628
"se.bsnet.fukt.Mandos"})
2629
class MandosDBusService(DBusObjectWithProperties):
2001
class MandosDBusService(dbus.service.Object):
2630
2002
"""A D-Bus proxy object"""
2631
2003
def __init__(self):
2632
2004
dbus.service.Object.__init__(self, bus, "/")
2633
_interface = "se.recompile.Mandos"
2634
2635
@dbus_interface_annotations(_interface)
2636
def _foo(self):
2637
return { "org.freedesktop.DBus.Property"
2638
".EmitsChangedSignal":
2639
"false"}
2005
_interface = "se.bsnet.fukt.Mandos"
2640
2006
2641
2007
@dbus.service.signal(_interface, signature="o")
2642
2008
def ClientAdded(self, objpath):
2657
2023
def GetAllClients(self):
2658
2024
"D-Bus method"
2659
2025
return dbus.Array(c.dbus_object_path
2660
for c in
2661
tcp_server.clients.itervalues())
2026
for c in tcp_server.clients)
2662
2027
2663
2028
@dbus.service.method(_interface,
2664
2029
out_signature="a{oa{sv}}")
2666
2031
"D-Bus method"
2667
2032
return dbus.Dictionary(
2668
2033
((c.dbus_object_path, c.GetAll(""))
2669
for c in tcp_server.clients.itervalues()),
2034
for c in tcp_server.clients),
2670
2035
signature="oa{sv}")
2671
2036
2672
2037
@dbus.service.method(_interface, in_signature="o")
2673
2038
def RemoveClient(self, object_path):
2674
2039
"D-Bus method"
2675
for c in tcp_server.clients.itervalues():
2040
for c in tcp_server.clients:
2676
2041
if c.dbus_object_path == object_path:
2677
del tcp_server.clients[c.name]
2042
tcp_server.clients.remove(c)
2678
2043
c.remove_from_connection()
2679
2044
# Don't signal anything except ClientRemoved
2680
2045
c.disable(quiet=True)
2685
2050
2686
2051
del _interface
2687
2052
2688
mandos_dbus_service = MandosDBusService()
2053
class MandosDBusServiceTransitional(MandosDBusService):
2054
__metaclass__ = transitional_dbus_metaclass
2055
mandos_dbus_service = MandosDBusServiceTransitional()
2689
2056
2690
2057
def cleanup():
2691
2058
"Cleanup function; run on exit"
2692
2059
service.cleanup()
2693
2060
2694
multiprocessing.active_children()
2695
if not (tcp_server.clients or client_settings):
2696
return
2697
2698
# Store client before exiting. Secrets are encrypted with key
2699
# based on what config file has. If config file is
2700
# removed/edited, old secret will thus be unrecovable.
2701
clients = {}
2702
with PGPEngine() as pgp:
2703
for client in tcp_server.clients.itervalues():
2704
key = client_settings[client.name]["secret"]
2705
client.encrypted_secret = pgp.encrypt(client.secret,
2706
key)
2707
client_dict = {}
2708
2709
# A list of attributes that can not be pickled
2710
# + secret.
2711
exclude = set(("bus", "changedstate", "secret",
2712
"checker"))
2713
for name, typ in (inspect.getmembers
2714
(dbus.service.Object)):
2715
exclude.add(name)
2716
2717
client_dict["encrypted_secret"] = (client
2718
.encrypted_secret)
2719
for attr in client.client_structure:
2720
if attr not in exclude:
2721
client_dict[attr] = getattr(client, attr)
2722
2723
clients[client.name] = client_dict
2724
del client_settings[client.name]["secret"]
2725
2726
try:
2727
with (tempfile.NamedTemporaryFile
2728
(mode='wb', suffix=".pickle", prefix='clients-',
2729
dir=os.path.dirname(stored_state_path),
2730
delete=False)) as stored_state:
2731
pickle.dump((clients, client_settings), stored_state)
2732
tempname=stored_state.name
2733
os.rename(tempname, stored_state_path)
2734
except (IOError, OSError) as e:
2735
if not debug:
2736
try:
2737
os.remove(tempname)
2738
except NameError:
2739
pass
2740
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2741
logger.warning("Could not save persistent state: {0}"
2742
.format(os.strerror(e.errno)))
2743
else:
2744
logger.warning("Could not save persistent state:",
2745
exc_info=e)
2746
raise e
2747
2748
# Delete all clients, and settings from config
2749
2061
while tcp_server.clients:
2750
name, client = tcp_server.clients.popitem()
2062
client = tcp_server.clients.pop()
2751
2063
if use_dbus:
2752
2064
client.remove_from_connection()
2065
client.disable_hook = None
2753
2066
# Don't signal anything except ClientRemoved
2754
2067
client.disable(quiet=True)
2755
2068
if use_dbus:
2756
2069
# Emit D-Bus signal
2757
mandos_dbus_service.ClientRemoved(client
2758
.dbus_object_path,
2070
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2759
2071
client.name)
2760
client_settings.clear()
2761
2072
2762
2073
atexit.register(cleanup)
2763
2074
2764
for client in tcp_server.clients.itervalues():
2075
for client in tcp_server.clients:
2765
2076
if use_dbus:
2766
2077
# Emit D-Bus signal
2767
2078
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2768
# Need to initiate checking of clients
2769
if client.enabled:
2770
client.init_checker()
2079
client.enable()
2771
2080
2772
2081
tcp_server.enable()
2773
2082
tcp_server.server_activate()
2776
2085
service.port = tcp_server.socket.getsockname()[1]
2777
2086
if use_ipv6:
2778
2087
logger.info("Now listening on address %r, port %d,"
2779
" flowinfo %d, scope_id %d",
2780
*tcp_server.socket.getsockname())
2088
" flowinfo %d, scope_id %d"
2089
% tcp_server.socket.getsockname())
2781
2090
else: # IPv4
2782
logger.info("Now listening on address %r, port %d",
2783
*tcp_server.socket.getsockname())
2091
logger.info("Now listening on address %r, port %d"
2092
% tcp_server.socket.getsockname())
2784
2093
2785
2094
#service.interface = tcp_server.socket.getsockname()[3]
2786
2095
2789
2098
try:
2790
2099
service.activate()
2791
2100
except dbus.exceptions.DBusException as error:
2792
logger.critical("D-Bus Exception", exc_info=error)
2101
logger.critical("DBusException: %s", error)
2793
2102
cleanup()
2794
2103
sys.exit(1)
2795
2104
# End of Avahi example code
2802
2111
logger.debug("Starting main loop")
2803
2112
main_loop.run()
2804
2113
except AvahiError as error:
2805
logger.critical("Avahi Error", exc_info=error)
2114
logger.critical("AvahiError: %s", error)
2806
2115
cleanup()
2807
2116
sys.exit(1)
2808
2117
except KeyboardInterrupt:
2813
2122
# Must run before the D-Bus bus name gets deregistered
2814
2123
cleanup()
2815
2124
2125
2816
2126
if __name__ == '__main__':
2817
2127
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0