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 609
- compare with another revision
- download diff
- download tarball
- view history from revision 609
- Committer: Teddy Hogeborn
- Date: 2012-06-23 00:58:49 UTC
- Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
duration.
(rfc3339_duration_to_delta): New function.
(string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
(EXAMPLE): Update to new interval format.
(SEE ALSO): Reference RFC 3339.
* mandos: All client options for time intervals now take an RFC 3339
duration.
(rfc3339_duration_to_delta): New function.
(string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
(EXAMPLE): Update to new interval format.
(SEE ALSO): Reference RFC 3339.
- files added:
- debian/mandos-client.examples
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 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@fukt.bsnet.se>.
31
# Contact the authors at <mandos@recompile.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
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
63
65
import cPickle as pickle
64
66
import multiprocessing
65
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
66
72
67
73
import dbus
68
74
import dbus.service
73
79
import ctypes.util
74
80
import xml.dom.minidom
75
81
import inspect
82
import GnuPGInterface
76
83
77
84
try:
78
85
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
82
89
except ImportError:
83
90
SO_BINDTODEVICE = None
84
91
85
86
version = "1.3.1"
87
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
92
version = "1.6.0"
93
stored_state_file = "clients.pickle"
94
95
logger = logging.getLogger()
90
96
syslogger = (logging.handlers.SysLogHandler
91
97
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
98
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
95
' %(message)s'))
96
logger.addHandler(syslogger)
97
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
' %(levelname)s:'
101
' %(message)s'))
102
logger.addHandler(console)
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
103
214
104
215
class AvahiError(Exception):
105
216
def __init__(self, value, *args, **kwargs):
135
246
server: D-Bus Server
136
247
bus: dbus.SystemBus()
137
248
"""
249
138
250
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
251
servicetype = None, port = None, TXT = None,
140
252
domain = "", host = "", max_renames = 32768,
153
265
self.server = None
154
266
self.bus = bus
155
267
self.entry_group_state_changed_match = None
268
156
269
def rename(self):
157
270
"""Derived from the Avahi example code"""
158
271
if self.rename_count >= self.max_renames:
160
273
" after %i retries, exiting.",
161
274
self.rename_count)
162
275
raise AvahiServiceError("Too many renames")
163
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
276
self.name = unicode(self.server
277
.GetAlternativeServiceName(self.name))
164
278
logger.info("Changing Zeroconf service name to %r ...",
165
279
self.name)
166
syslogger.setFormatter(logging.Formatter
167
('Mandos (%s) [%%(process)d]:'
168
' %%(levelname)s: %%(message)s'
169
% self.name))
170
280
self.remove()
171
281
try:
172
282
self.add()
173
283
except dbus.exceptions.DBusException as error:
174
logger.critical("DBusException: %s", error)
284
logger.critical("D-Bus Exception", exc_info=error)
175
285
self.cleanup()
176
286
os._exit(1)
177
287
self.rename_count += 1
288
178
289
def remove(self):
179
290
"""Derived from the Avahi example code"""
180
291
if self.entry_group_state_changed_match is not None:
182
293
self.entry_group_state_changed_match = None
183
294
if self.group is not None:
184
295
self.group.Reset()
296
185
297
def add(self):
186
298
"""Derived from the Avahi example code"""
187
299
self.remove()
192
304
avahi.DBUS_INTERFACE_ENTRY_GROUP)
193
305
self.entry_group_state_changed_match = (
194
306
self.group.connect_to_signal(
195
'StateChanged', self .entry_group_state_changed))
307
'StateChanged', self.entry_group_state_changed))
196
308
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
197
309
self.name, self.type)
198
310
self.group.AddService(
204
316
dbus.UInt16(self.port),
205
317
avahi.string_array_to_txt_array(self.TXT))
206
318
self.group.Commit()
319
207
320
def entry_group_state_changed(self, state, error):
208
321
"""Derived from the Avahi example code"""
209
322
logger.debug("Avahi entry group state change: %i", state)
216
329
elif state == avahi.ENTRY_GROUP_FAILURE:
217
330
logger.critical("Avahi: Error in group state changed %s",
218
331
unicode(error))
219
raise AvahiGroupError("State changed: %s"
220
% unicode(error))
332
raise AvahiGroupError("State changed: {0!s}"
333
.format(error))
334
221
335
def cleanup(self):
222
336
"""Derived from the Avahi example code"""
223
337
if self.group is not None:
224
338
try:
225
339
self.group.Free()
226
340
except (dbus.exceptions.UnknownMethodException,
227
dbus.exceptions.DBusException) as e:
341
dbus.exceptions.DBusException):
228
342
pass
229
343
self.group = None
230
344
self.remove()
345
231
346
def server_state_changed(self, state, error=None):
232
347
"""Derived from the Avahi example code"""
233
348
logger.debug("Avahi server state change: %i", state)
252
367
logger.debug("Unknown state: %r", state)
253
368
else:
254
369
logger.debug("Unknown state: %r: %r", state, error)
370
255
371
def activate(self):
256
372
"""Derived from the Avahi example code"""
257
373
if self.server is None:
265
381
self.server_state_changed(self.server.GetState())
266
382
267
383
268
def _timedelta_to_milliseconds(td):
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):
269
396
"Convert a datetime.timedelta() to milliseconds"
270
397
return ((td.days * 24 * 60 * 60 * 1000)
271
398
+ (td.seconds * 1000)
272
399
+ (td.microseconds // 1000))
273
400
401
274
402
class Client(object):
275
403
"""A representation of a client host served by this server.
276
404
277
405
Attributes:
278
_approved: bool(); 'None' if not yet approved/disapproved
406
approved: bool(); 'None' if not yet approved/disapproved
279
407
approval_delay: datetime.timedelta(); Time to wait for approval
280
408
approval_duration: datetime.timedelta(); Duration of one approval
281
409
checker: subprocess.Popen(); a running checker process used
288
416
instance %(name)s can be used in the command.
289
417
checker_initiator_tag: a gobject event source tag, or None
290
418
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
291
421
current_checker_command: string; current running checker_command
292
disable_hook: If set, called by disable() as disable_hook(self)
293
422
disable_initiator_tag: a gobject event source tag, or None
294
423
enabled: bool()
295
424
fingerprint: string (40 or 32 hexadecimal digits); used to
298
427
interval: datetime.timedelta(); How often to start a new checker
299
428
last_approval_request: datetime.datetime(); (UTC) or None
300
429
last_checked_ok: datetime.datetime(); (UTC) or None
301
last_enabled: datetime.datetime(); (UTC)
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
302
434
name: string; from the config file, used in log messages and
303
435
D-Bus identifiers
304
436
secret: bytestring; sent verbatim (over TLS) to client
305
437
timeout: datetime.timedelta(); How long from last_checked_ok
306
438
until this client is disabled
307
extended_timeout: extra long timeout when password has been sent
439
extended_timeout: extra long timeout when secret has been sent
308
440
runtime_expansions: Allowed attributes for runtime expansion.
309
441
expires: datetime.datetime(); time (UTC) when a client will be
310
442
disabled, or None
311
443
"""
312
444
313
445
runtime_expansions = ("approval_delay", "approval_duration",
314
"created", "enabled", "fingerprint",
315
"host", "interval", "last_checked_ok",
446
"created", "enabled", "expires",
447
"fingerprint", "host", "interval",
448
"last_approval_request", "last_checked_ok",
316
449
"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
}
317
460
318
461
def timeout_milliseconds(self):
319
462
"Return the 'timeout' attribute in milliseconds"
320
return _timedelta_to_milliseconds(self.timeout)
463
return timedelta_to_milliseconds(self.timeout)
321
464
322
465
def extended_timeout_milliseconds(self):
323
466
"Return the 'extended_timeout' attribute in milliseconds"
324
return _timedelta_to_milliseconds(self.extended_timeout)
467
return timedelta_to_milliseconds(self.extended_timeout)
325
468
326
469
def interval_milliseconds(self):
327
470
"Return the 'interval' attribute in milliseconds"
328
return _timedelta_to_milliseconds(self.interval)
471
return timedelta_to_milliseconds(self.interval)
329
472
330
473
def approval_delay_milliseconds(self):
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."""
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):
337
524
self.name = name
338
if config is None:
339
config = {}
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
340
539
logger.debug("Creating client %r", self.name)
341
540
# Uppercase and remove spaces from fingerprint for later
342
541
# comparison purposes with return value from the fingerprint()
343
542
# function
344
self.fingerprint = (config["fingerprint"].upper()
345
.replace(" ", ""))
346
543
logger.debug(" Fingerprint: %s", self.fingerprint)
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
544
self.created = settings.get("created",
545
datetime.datetime.utcnow())
546
547
# attributes specific for this server instance
367
548
self.checker = None
368
549
self.checker_initiator_tag = None
369
550
self.disable_initiator_tag = None
370
self.expires = None
371
551
self.checker_callback_tag = None
372
self.checker_command = config["checker"]
373
552
self.current_checker_command = None
374
self.last_connect = None
375
self._approved = None
376
self.approved_by_default = config.get("approved_by_default",
377
True)
553
self.approved = None
378
554
self.approvals_pending = 0
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())
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)
384
569
570
# Send notice to process children that client state has changed
385
571
def send_changedstate(self):
386
self.changedstate.acquire()
387
self.changedstate.notify_all()
388
self.changedstate.release()
389
572
with self.changedstate:
573
self.changedstate.notify_all()
574
390
575
def enable(self):
391
576
"""Start this client's checker and timeout hooks"""
392
577
if getattr(self, "enabled", False):
393
578
# Already enabled
394
579
return
580
self.expires = datetime.datetime.utcnow() + self.timeout
581
self.enabled = True
582
self.last_enabled = datetime.datetime.utcnow()
583
self.init_checker()
395
584
self.send_changedstate()
585
586
def disable(self, quiet=True):
587
"""Disable this client."""
588
if not getattr(self, "enabled", False):
589
return False
590
if not quiet:
591
logger.info("Disabling client %s", self.name)
592
if getattr(self, "disable_initiator_tag", None) is not None:
593
gobject.source_remove(self.disable_initiator_tag)
594
self.disable_initiator_tag = None
595
self.expires = None
596
if getattr(self, "checker_initiator_tag", None) is not None:
597
gobject.source_remove(self.checker_initiator_tag)
598
self.checker_initiator_tag = None
599
self.stop_checker()
600
self.enabled = False
601
if not quiet:
602
self.send_changedstate()
603
# Do not run this again if called by a gobject.timeout_add
604
return False
605
606
def __del__(self):
607
self.disable()
608
609
def init_checker(self):
396
610
# Schedule a new checker to be started an 'interval' from now,
397
611
# and every interval from then on.
612
if self.checker_initiator_tag is not None:
613
gobject.source_remove(self.checker_initiator_tag)
398
614
self.checker_initiator_tag = (gobject.timeout_add
399
615
(self.interval_milliseconds(),
400
616
self.start_checker))
401
617
# Schedule a disable() when 'timeout' has passed
402
self.expires = datetime.datetime.utcnow() + self.timeout
618
if self.disable_initiator_tag is not None:
619
gobject.source_remove(self.disable_initiator_tag)
403
620
self.disable_initiator_tag = (gobject.timeout_add
404
621
(self.timeout_milliseconds(),
405
622
self.disable))
406
self.enabled = True
407
self.last_enabled = datetime.datetime.utcnow()
408
623
# Also start a new checker *right now*.
409
624
self.start_checker()
410
625
411
def disable(self, quiet=True):
412
"""Disable this client."""
413
if not getattr(self, "enabled", False):
414
return False
415
if not quiet:
416
self.send_changedstate()
417
if not quiet:
418
logger.info("Disabling client %s", self.name)
419
if getattr(self, "disable_initiator_tag", False):
420
gobject.source_remove(self.disable_initiator_tag)
421
self.disable_initiator_tag = None
422
self.expires = None
423
if getattr(self, "checker_initiator_tag", False):
424
gobject.source_remove(self.checker_initiator_tag)
425
self.checker_initiator_tag = None
426
self.stop_checker()
427
if self.disable_hook:
428
self.disable_hook(self)
429
self.enabled = False
430
# Do not run this again if called by a gobject.timeout_add
431
return False
432
433
def __del__(self):
434
self.disable_hook = None
435
self.disable()
436
437
626
def checker_callback(self, pid, condition, command):
438
627
"""The checker has completed, so take appropriate actions."""
439
628
self.checker_callback_tag = None
440
629
self.checker = None
441
630
if os.WIFEXITED(condition):
442
exitstatus = os.WEXITSTATUS(condition)
443
if exitstatus == 0:
631
self.last_checker_status = os.WEXITSTATUS(condition)
632
if self.last_checker_status == 0:
444
633
logger.info("Checker for %(name)s succeeded",
445
634
vars(self))
446
635
self.checked_ok()
448
637
logger.info("Checker for %(name)s failed",
449
638
vars(self))
450
639
else:
640
self.last_checker_status = -1
451
641
logger.warning("Checker for %(name)s crashed?",
452
642
vars(self))
453
643
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
"""
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."""
460
652
if timeout is None:
461
653
timeout = self.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))
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
468
662
469
663
def need_approval(self):
470
664
self.last_approval_request = datetime.datetime.utcnow()
475
669
If a checker already exists, leave it running and do
476
670
nothing."""
477
671
# The reason for not killing a running checker is that if we
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
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
482
676
# checkers alone, the checker would have to take more time
483
677
# than 'timeout' for the client to be disabled, which is as it
484
678
# should be.
498
692
self.current_checker_command)
499
693
# Start a new checker if needed
500
694
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)
501
700
try:
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
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
520
706
self.current_checker_command = command
521
707
try:
522
708
logger.info("Starting checker %r for %s",
528
714
self.checker = subprocess.Popen(command,
529
715
close_fds=True,
530
716
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)
541
717
except OSError as error:
542
logger.error("Failed to start subprocess: %s",
543
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)
544
730
# Re-run this periodically if run by gobject.timeout_add
545
731
return True
546
732
553
739
return
554
740
logger.debug("Stopping checker for %(name)s", vars(self))
555
741
try:
556
os.kill(self.checker.pid, signal.SIGTERM)
742
self.checker.terminate()
557
743
#time.sleep(0.5)
558
744
#if self.checker.poll() is None:
559
# os.kill(self.checker.pid, signal.SIGKILL)
745
# self.checker.kill()
560
746
except OSError as error:
561
747
if error.errno != errno.ESRCH: # No such process
562
748
raise
579
765
# "Set" method, so we fail early here:
580
766
if byte_arrays and signature != "ay":
581
767
raise ValueError("Byte arrays not supported for non-'ay'"
582
" signature %r" % signature)
768
" signature {0!r}".format(signature))
583
769
def decorator(func):
584
770
func._dbus_is_property = True
585
771
func._dbus_interface = dbus_interface
593
779
return decorator
594
780
595
781
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
596
819
class DBusPropertyException(dbus.exceptions.DBusException):
597
820
"""A base class for D-Bus property-related exceptions
598
821
"""
621
844
"""
622
845
623
846
@staticmethod
624
def _is_dbus_property(obj):
625
return getattr(obj, "_dbus_is_property", False)
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)
626
855
627
def _get_all_dbus_properties(self):
856
def _get_all_dbus_things(self, thing):
628
857
"""Returns a generator of (name, attribute) pairs
629
858
"""
630
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
859
return ((getattr(athing.__get__(self), "_dbus_name",
860
name),
861
athing.__get__(self))
631
862
for cls in self.__class__.__mro__
632
for name, prop in inspect.getmembers(cls, self._is_dbus_property))
863
for name, athing in
864
inspect.getmembers(cls,
865
self._is_dbus_thing(thing)))
633
866
634
867
def _get_dbus_property(self, interface_name, property_name):
635
868
"""Returns a bound method if one exists which is a D-Bus
636
869
property with the specified name and interface.
637
870
"""
638
871
for cls in self.__class__.__mro__:
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:
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):
641
877
return value.__get__(self)
642
878
643
879
# No such property
644
880
raise DBusPropertyNotFound(self.dbus_object_path + ":"
645
881
+ interface_name + "."
646
882
+ property_name)
647
648
883
649
884
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
650
885
out_signature="v")
671
906
# signatures other than "ay".
672
907
if prop._dbus_signature != "ay":
673
908
raise ValueError
674
value = dbus.ByteArray(''.join(unichr(byte)
675
for byte in value))
909
value = dbus.ByteArray(b''.join(chr(byte)
910
for byte in value))
676
911
prop(value)
677
912
678
913
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
683
918
684
919
Note: Will not include properties with access="write".
685
920
"""
686
all = {}
687
for name, prop in self._get_all_dbus_properties():
921
properties = {}
922
for name, prop in self._get_all_dbus_things("property"):
688
923
if (interface_name
689
924
and interface_name != prop._dbus_interface):
690
925
# Interface non-empty but did not match
694
929
continue
695
930
value = prop()
696
931
if not hasattr(value, "variant_level"):
697
all[name] = value
932
properties[name] = value
698
933
continue
699
all[name] = type(value)(value, variant_level=
700
value.variant_level+1)
701
return dbus.Dictionary(all, signature="sv")
934
properties[name] = type(value)(value, variant_level=
935
value.variant_level+1)
936
return dbus.Dictionary(properties, signature="sv")
702
937
703
938
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
704
939
out_signature="s",
705
940
path_keyword='object_path',
706
941
connection_keyword='connection')
707
942
def Introspect(self, object_path, connection):
708
"""Standard D-Bus method, overloaded to insert property tags.
943
"""Overloading of standard D-Bus method.
944
945
Inserts property tags and interface annotation tags.
709
946
"""
710
947
xmlstring = dbus.service.Object.Introspect(self, object_path,
711
948
connection)
718
955
e.setAttribute("access", prop._dbus_access)
719
956
return e
720
957
for if_tag in document.getElementsByTagName("interface"):
958
# Add property tags
721
959
for tag in (make_tag(document, name, prop)
722
960
for name, prop
723
in self._get_all_dbus_properties()
961
in self._get_all_dbus_things("property")
724
962
if prop._dbus_interface
725
963
== if_tag.getAttribute("name")):
726
964
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)
727
996
# Add the names to the return values for the
728
997
# "org.freedesktop.DBus.Properties" methods
729
998
if (if_tag.getAttribute("name")
744
1013
except (AttributeError, xml.dom.DOMException,
745
1014
xml.parsers.expat.ExpatError) as error:
746
1015
logger.error("Failed to override Introspection method",
747
error)
1016
exc_info=error)
748
1017
return xmlstring
749
1018
750
1019
751
def datetime_to_dbus (dt, variant_level=0):
1020
def datetime_to_dbus(dt, variant_level=0):
752
1021
"""Convert a UTC datetime.datetime() to a D-Bus type."""
753
1022
if dt is None:
754
1023
return dbus.String("", variant_level = variant_level)
755
1024
return dbus.String(dt.isoformat(),
756
1025
variant_level=variant_level)
757
1026
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
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"})
814
1199
class ClientDBus(Client, DBusObjectWithProperties):
815
1200
"""A Client class using D-Bus
816
1201
825
1210
# dbus.service.Object doesn't use super(), so we can't either.
826
1211
827
1212
def __init__(self, bus = None, *args, **kwargs):
828
self._approvals_pending = 0
829
1213
self.bus = bus
830
1214
Client.__init__(self, *args, **kwargs)
831
1215
# Only now, when this client is initialized, can it show up on
837
1221
("/clients/" + client_object_name))
838
1222
DBusObjectWithProperties.__init__(self, self.bus,
839
1223
self.dbus_object_path)
840
1224
841
1225
def notifychangeproperty(transform_func,
842
1226
dbus_name, type_func=lambda x: x,
843
1227
variant_level=1):
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
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
849
1234
type_func: Function that transform the value before sending it
850
to DBus
851
variant_level: DBus variant level. default: 1
1235
to the D-Bus. Default: no transform
1236
variant_level: D-Bus variant level. Default: 1
852
1237
"""
853
real_value = [None,]
1238
attrname = "_{0}".format(dbus_name)
854
1239
def setter(self, value):
855
old_value = real_value[0]
856
real_value[0] = value
857
1240
if hasattr(self, "dbus_object_path"):
858
if type_func(old_value) != type_func(real_value[0]):
859
dbus_value = transform_func(type_func(real_value[0]),
860
variant_level)
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)
861
1247
self.PropertyChanged(dbus.String(dbus_name),
862
1248
dbus_value)
1249
setattr(self, attrname, value)
863
1250
864
return property(lambda self: real_value[0], setter)
865
1251
return property(lambda self: getattr(self, attrname), setter)
866
1252
867
1253
expires = notifychangeproperty(datetime_to_dbus, "Expires")
868
1254
approvals_pending = notifychangeproperty(dbus.Boolean,
872
1258
last_enabled = notifychangeproperty(datetime_to_dbus,
873
1259
"LastEnabled")
874
1260
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
875
type_func = lambda checker: checker is not None)
1261
type_func = lambda checker:
1262
checker is not None)
876
1263
last_checked_ok = notifychangeproperty(datetime_to_dbus,
877
1264
"LastCheckedOK")
878
last_approval_request = notifychangeproperty(datetime_to_dbus,
879
"LastApprovalRequest")
1265
last_checker_status = notifychangeproperty(dbus.Int16,
1266
"LastCheckerStatus")
1267
last_approval_request = notifychangeproperty(
1268
datetime_to_dbus, "LastApprovalRequest")
880
1269
approved_by_default = notifychangeproperty(dbus.Boolean,
881
1270
"ApprovedByDefault")
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)
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)
886
1278
host = notifychangeproperty(dbus.String, "Host")
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)
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)
893
1289
checker_command = notifychangeproperty(dbus.String, "Checker")
894
1290
895
1291
del notifychangeproperty
937
1333
return r
938
1334
939
1335
def _reset_approved(self):
940
self._approved = None
1336
self.approved = None
941
1337
return False
942
1338
943
1339
def approve(self, value=True):
944
self.send_changedstate()
945
self._approved = value
946
gobject.timeout_add(_timedelta_to_milliseconds
1340
self.approved = value
1341
gobject.timeout_add(timedelta_to_milliseconds
947
1342
(self.approval_duration),
948
1343
self._reset_approved)
949
1344
self.send_changedstate()
950
1345
951
1346
## D-Bus methods, signals & properties
952
_interface = "se.bsnet.fukt.Mandos.Client"
953
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
954
1356
## Signals
955
1357
956
1358
# CheckerCompleted - signal
1055
1457
access="readwrite")
1056
1458
def ApprovalDuration_dbus_property(self, value=None):
1057
1459
if value is None: # get
1058
return dbus.UInt64(_timedelta_to_milliseconds(
1460
return dbus.UInt64(timedelta_to_milliseconds(
1059
1461
self.approval_duration))
1060
1462
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1061
1463
1075
1477
def Host_dbus_property(self, value=None):
1076
1478
if value is None: # get
1077
1479
return dbus.String(self.host)
1078
self.host = value
1480
self.host = unicode(value)
1079
1481
1080
1482
# Created - property
1081
1483
@dbus_service_property(_interface, signature="s", access="read")
1082
1484
def Created_dbus_property(self):
1083
return dbus.String(datetime_to_dbus(self.created))
1485
return datetime_to_dbus(self.created)
1084
1486
1085
1487
# LastEnabled - property
1086
1488
@dbus_service_property(_interface, signature="s", access="read")
1107
1509
return
1108
1510
return datetime_to_dbus(self.last_checked_ok)
1109
1511
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
1110
1518
# Expires - property
1111
1519
@dbus_service_property(_interface, signature="s", access="read")
1112
1520
def Expires_dbus_property(self):
1123
1531
def Timeout_dbus_property(self, value=None):
1124
1532
if value is None: # get
1125
1533
return dbus.UInt64(self.timeout_milliseconds())
1534
old_timeout = self.timeout
1126
1535
self.timeout = datetime.timedelta(0, 0, 0, value)
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))
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))
1147
1552
1148
1553
# ExtendedTimeout - property
1149
1554
@dbus_service_property(_interface, signature="t",
1162
1567
self.interval = datetime.timedelta(0, 0, 0, value)
1163
1568
if getattr(self, "checker_initiator_tag", None) is None:
1164
1569
return
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
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
1170
1576
1171
1577
# Checker - property
1172
1578
@dbus_service_property(_interface, signature="s",
1174
1580
def Checker_dbus_property(self, value=None):
1175
1581
if value is None: # get
1176
1582
return dbus.String(self.checker_command)
1177
self.checker_command = value
1583
self.checker_command = unicode(value)
1178
1584
1179
1585
# CheckerRunning - property
1180
1586
@dbus_service_property(_interface, signature="b",
1209
1615
raise KeyError()
1210
1616
1211
1617
def __getattribute__(self, name):
1212
if(name == '_pipe'):
1618
if name == '_pipe':
1213
1619
return super(ProxyClient, self).__getattribute__(name)
1214
1620
self._pipe.send(('getattr', name))
1215
1621
data = self._pipe.recv()
1222
1628
return func
1223
1629
1224
1630
def __setattr__(self, name, value):
1225
if(name == '_pipe'):
1631
if name == '_pipe':
1226
1632
return super(ProxyClient, self).__setattr__(name, value)
1227
1633
self._pipe.send(('setattr', name, value))
1228
1634
1229
class ClientDBusTransitional(ClientDBus):
1230
__metaclass__ = transitional_dbus_metaclass
1231
1635
1232
1636
class ClientHandler(socketserver.BaseRequestHandler, object):
1233
1637
"""A class to handle client connections.
1313
1717
client.name)
1314
1718
if self.server.use_dbus:
1315
1719
# Emit D-Bus signal
1316
client.Rejected("Disabled")
1720
client.Rejected("Disabled")
1317
1721
return
1318
1722
1319
if client._approved or not client.approval_delay:
1723
if client.approved or not client.approval_delay:
1320
1724
#We are approved or approval is disabled
1321
1725
break
1322
elif client._approved is None:
1726
elif client.approved is None:
1323
1727
logger.info("Client %s needs approval",
1324
1728
client.name)
1325
1729
if self.server.use_dbus:
1336
1740
return
1337
1741
1338
1742
#wait until timeout or approved
1339
#x = float(client._timedelta_to_milliseconds(delay))
1340
1743
time = datetime.datetime.now()
1341
1744
client.changedstate.acquire()
1342
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1745
client.changedstate.wait(
1746
float(timedelta_to_milliseconds(delay)
1747
/ 1000))
1343
1748
client.changedstate.release()
1344
1749
time2 = datetime.datetime.now()
1345
1750
if (time2 - time) >= delay:
1361
1766
try:
1362
1767
sent = session.send(client.secret[sent_size:])
1363
1768
except gnutls.errors.GNUTLSError as error:
1364
logger.warning("gnutls send failed")
1769
logger.warning("gnutls send failed",
1770
exc_info=error)
1365
1771
return
1366
1772
logger.debug("Sent: %d, remaining: %d",
1367
1773
sent, len(client.secret)
1369
1775
sent_size += sent
1370
1776
1371
1777
logger.info("Sending secret to %s", client.name)
1372
# bump the timeout as if seen
1373
client.checked_ok(client.extended_timeout)
1778
# bump the timeout using extended_timeout
1779
client.bump_timeout(client.extended_timeout)
1374
1780
if self.server.use_dbus:
1375
1781
# Emit D-Bus signal
1376
1782
client.GotSecret()
1381
1787
try:
1382
1788
session.bye()
1383
1789
except gnutls.errors.GNUTLSError as error:
1384
logger.warning("GnuTLS bye failed")
1790
logger.warning("GnuTLS bye failed",
1791
exc_info=error)
1385
1792
1386
1793
@staticmethod
1387
1794
def peer_certificate(session):
1443
1850
# Convert the buffer to a Python bytestring
1444
1851
fpr = ctypes.string_at(buf, buf_len.value)
1445
1852
# Convert the bytestring to hexadecimal notation
1446
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1853
hex_fpr = binascii.hexlify(fpr).upper()
1447
1854
return hex_fpr
1448
1855
1449
1856
1452
1859
def sub_process_main(self, request, address):
1453
1860
try:
1454
1861
self.finish_request(request, address)
1455
except:
1862
except Exception:
1456
1863
self.handle_error(request, address)
1457
1864
self.close_request(request)
1458
1865
1459
1866
def process_request(self, request, address):
1460
1867
"""Start a new process to process the request."""
1461
multiprocessing.Process(target = self.sub_process_main,
1462
args = (request, address)).start()
1868
proc = multiprocessing.Process(target = self.sub_process_main,
1869
args = (request, address))
1870
proc.start()
1871
return proc
1463
1872
1464
1873
1465
1874
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1471
1880
"""
1472
1881
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1473
1882
1474
super(MultiprocessingMixInWithPipe,
1475
self).process_request(request, client_address)
1883
proc = MultiprocessingMixIn.process_request(self, request,
1884
client_address)
1476
1885
self.child_pipe.close()
1477
self.add_pipe(parent_pipe)
1886
self.add_pipe(parent_pipe, proc)
1478
1887
1479
def add_pipe(self, parent_pipe):
1888
def add_pipe(self, parent_pipe, proc):
1480
1889
"""Dummy function; override as necessary"""
1481
1890
raise NotImplementedError
1482
1891
1491
1900
use_ipv6: Boolean; to use IPv6 or not
1492
1901
"""
1493
1902
def __init__(self, server_address, RequestHandlerClass,
1494
interface=None, use_ipv6=True):
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
"""
1495
1907
self.interface = interface
1496
1908
if use_ipv6:
1497
1909
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.
1498
1936
socketserver.TCPServer.__init__(self, server_address,
1499
1937
RequestHandlerClass)
1938
1500
1939
def server_bind(self):
1501
1940
"""This overrides the normal server_bind() function
1502
1941
to bind to an interface if one was specified, and also NOT to
1510
1949
try:
1511
1950
self.socket.setsockopt(socket.SOL_SOCKET,
1512
1951
SO_BINDTODEVICE,
1513
str(self.interface
1514
+ '\0'))
1952
str(self.interface + '\0'))
1515
1953
except socket.error as error:
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:
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:
1521
1958
logger.error("SO_BINDTODEVICE not available;"
1522
1959
" cannot bind to interface %s",
1523
1960
self.interface)
1961
elif error.errno == errno.ENODEV:
1962
logger.error("Interface %s does not exist,"
1963
" cannot bind", self.interface)
1524
1964
else:
1525
1965
raise
1526
1966
# Only bind(2) the socket if we really need to.
1556
1996
"""
1557
1997
def __init__(self, server_address, RequestHandlerClass,
1558
1998
interface=None, use_ipv6=True, clients=None,
1559
gnutls_priority=None, use_dbus=True):
1999
gnutls_priority=None, use_dbus=True, socketfd=None):
1560
2000
self.enabled = False
1561
2001
self.clients = clients
1562
2002
if self.clients is None:
1563
self.clients = set()
2003
self.clients = {}
1564
2004
self.use_dbus = use_dbus
1565
2005
self.gnutls_priority = gnutls_priority
1566
2006
IPv6_TCPServer.__init__(self, server_address,
1567
2007
RequestHandlerClass,
1568
2008
interface = interface,
1569
use_ipv6 = use_ipv6)
2009
use_ipv6 = use_ipv6,
2010
socketfd = socketfd)
1570
2011
def server_activate(self):
1571
2012
if self.enabled:
1572
2013
return socketserver.TCPServer.server_activate(self)
2014
1573
2015
def enable(self):
1574
2016
self.enabled = True
1575
def add_pipe(self, parent_pipe):
2017
2018
def add_pipe(self, parent_pipe, proc):
1576
2019
# Call "handle_ipc" for both data and EOF events
1577
2020
gobject.io_add_watch(parent_pipe.fileno(),
1578
2021
gobject.IO_IN | gobject.IO_HUP,
1579
2022
functools.partial(self.handle_ipc,
1580
parent_pipe = parent_pipe))
1581
2023
parent_pipe =
2024
parent_pipe,
2025
proc = proc))
2026
1582
2027
def handle_ipc(self, source, condition, parent_pipe=None,
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):
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()
1600
2033
return False
1601
2034
1602
2035
# Read a request from the child
1607
2040
fpr = request[1]
1608
2041
address = request[2]
1609
2042
1610
for c in self.clients:
2043
for c in self.clients.itervalues():
1611
2044
if c.fingerprint == fpr:
1612
2045
client = c
1613
2046
break
1616
2049
"dress: %s", fpr, address)
1617
2050
if self.use_dbus:
1618
2051
# Emit D-Bus signal
1619
mandos_dbus_service.ClientNotFound(fpr, address[0])
2052
mandos_dbus_service.ClientNotFound(fpr,
2053
address[0])
1620
2054
parent_pipe.send(False)
1621
2055
return False
1622
2056
1623
2057
gobject.io_add_watch(parent_pipe.fileno(),
1624
2058
gobject.IO_IN | gobject.IO_HUP,
1625
2059
functools.partial(self.handle_ipc,
1626
parent_pipe = parent_pipe,
1627
client_object = client))
2060
parent_pipe =
2061
parent_pipe,
2062
proc = proc,
2063
client_object =
2064
client))
1628
2065
parent_pipe.send(True)
1629
# remove the old hook in favor of the new above hook on same fileno
2066
# remove the old hook in favor of the new above hook on
2067
# same fileno
1630
2068
return False
1631
2069
if command == 'funcall':
1632
2070
funcname = request[1]
1633
2071
args = request[2]
1634
2072
kwargs = request[3]
1635
2073
1636
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2074
parent_pipe.send(('data', getattr(client_object,
2075
funcname)(*args,
2076
**kwargs)))
1637
2077
1638
2078
if command == 'getattr':
1639
2079
attrname = request[1]
1640
2080
if callable(client_object.__getattribute__(attrname)):
1641
2081
parent_pipe.send(('function',))
1642
2082
else:
1643
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2083
parent_pipe.send(('data', client_object
2084
.__getattribute__(attrname)))
1644
2085
1645
2086
if command == 'setattr':
1646
2087
attrname = request[1]
1650
2091
return True
1651
2092
1652
2093
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
1653
2193
def string_to_delta(interval):
1654
2194
"""Parse a string and return a datetime.timedelta
1655
2195
1666
2206
>>> string_to_delta('5m 30s')
1667
2207
datetime.timedelta(0, 330)
1668
2208
"""
2209
2210
try:
2211
return rfc3339_duration_to_delta(interval)
2212
except ValueError:
2213
pass
2214
1669
2215
timevalue = datetime.timedelta(0)
1670
2216
for s in interval.split():
1671
2217
try:
1682
2228
elif suffix == "w":
1683
2229
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1684
2230
else:
1685
raise ValueError("Unknown suffix %r" % suffix)
2231
raise ValueError("Unknown suffix {0!r}"
2232
.format(suffix))
1686
2233
except (ValueError, IndexError) as e:
1687
2234
raise ValueError(*(e.args))
1688
2235
timevalue += delta
1689
2236
return timevalue
1690
2237
1691
2238
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
1716
2239
def daemon(nochdir = False, noclose = False):
1717
2240
"""See daemon(3). Standard BSD Unix function.
1718
2241
1726
2249
sys.exit()
1727
2250
if not noclose:
1728
2251
# Close all standard open file descriptors
1729
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2252
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1730
2253
if not stat.S_ISCHR(os.fstat(null).st_mode):
1731
2254
raise OSError(errno.ENODEV,
1732
"%s not a character device"
1733
% os.path.devnull)
2255
"{0} not a character device"
2256
.format(os.devnull))
1734
2257
os.dup2(null, sys.stdin.fileno())
1735
2258
os.dup2(null, sys.stdout.fileno())
1736
2259
os.dup2(null, sys.stderr.fileno())
1745
2268
1746
2269
parser = argparse.ArgumentParser()
1747
2270
parser.add_argument("-v", "--version", action="version",
1748
version = "%%(prog)s %s" % version,
2271
version = "%(prog)s {0}".format(version),
1749
2272
help="show version number and exit")
1750
2273
parser.add_argument("-i", "--interface", metavar="IF",
1751
2274
help="Bind to interface IF")
1773
2296
" system bus interface")
1774
2297
parser.add_argument("--no-ipv6", action="store_false",
1775
2298
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
1776
2310
options = parser.parse_args()
1777
2311
1778
2312
if options.check:
1791
2325
"use_dbus": "True",
1792
2326
"use_ipv6": "True",
1793
2327
"debuglevel": "",
2328
"restore": "True",
2329
"socket": "",
2330
"statedir": "/var/lib/mandos",
2331
"foreground": "False",
1794
2332
}
1795
2333
1796
2334
# Parse config file for server-global settings
1801
2339
# Convert the SafeConfigParser object to a dict
1802
2340
server_settings = server_config.defaults()
1803
2341
# Use the appropriate methods on the non-string config options
1804
for option in ("debug", "use_dbus", "use_ipv6"):
2342
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1805
2343
server_settings[option] = server_config.getboolean("DEFAULT",
1806
2344
option)
1807
2345
if server_settings["port"]:
1808
2346
server_settings["port"] = server_config.getint("DEFAULT",
1809
2347
"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"])
1810
2357
del server_config
1811
2358
1812
2359
# Override the settings from the config file with command line
1813
2360
# options, if set.
1814
2361
for option in ("interface", "address", "port", "debug",
1815
2362
"priority", "servicename", "configdir",
1816
"use_dbus", "use_ipv6", "debuglevel"):
2363
"use_dbus", "use_ipv6", "debuglevel", "restore",
2364
"statedir", "socket", "foreground"):
1817
2365
value = getattr(options, option)
1818
2366
if value is not None:
1819
2367
server_settings[option] = value
1822
2370
for option in server_settings.keys():
1823
2371
if type(server_settings[option]) is str:
1824
2372
server_settings[option] = unicode(server_settings[option])
2373
# Debug implies foreground
2374
if server_settings["debug"]:
2375
server_settings["foreground"] = True
1825
2376
# Now we have our good server settings in "server_settings"
1826
2377
1827
2378
##################################################################
1831
2382
debuglevel = server_settings["debuglevel"]
1832
2383
use_dbus = server_settings["use_dbus"]
1833
2384
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)
1834
2397
1835
2398
if server_settings["servicename"] != "Mandos":
1836
2399
syslogger.setFormatter(logging.Formatter
1837
('Mandos (%s) [%%(process)d]:'
1838
' %%(levelname)s: %%(message)s'
1839
% server_settings["servicename"]))
2400
('Mandos ({0}) [%(process)d]:'
2401
' %(levelname)s: %(message)s'
2402
.format(server_settings
2403
["servicename"])))
1840
2404
1841
2405
# Parse config file with clients
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)
2406
client_config = configparser.SafeConfigParser(Client
2407
.client_defaults)
1851
2408
client_config.read(os.path.join(server_settings["configdir"],
1852
2409
"clients.conf"))
1853
2410
1862
2419
use_ipv6=use_ipv6,
1863
2420
gnutls_priority=
1864
2421
server_settings["priority"],
1865
use_dbus=use_dbus)
1866
if not debug:
2422
use_dbus=use_dbus,
2423
socketfd=(server_settings["socket"]
2424
or None))
2425
if not foreground:
1867
2426
pidfilename = "/var/run/mandos.pid"
2427
pidfile = None
1868
2428
try:
1869
2429
pidfile = open(pidfilename, "w")
1870
except IOError:
1871
logger.error("Could not open file %r", pidfilename)
2430
except IOError as e:
2431
logger.error("Could not open file %r", pidfilename,
2432
exc_info=e)
1872
2433
1873
try:
1874
uid = pwd.getpwnam("_mandos").pw_uid
1875
gid = pwd.getpwnam("_mandos").pw_gid
1876
except KeyError:
2434
for name in ("_mandos", "mandos", "nobody"):
1877
2435
try:
1878
uid = pwd.getpwnam("mandos").pw_uid
1879
gid = pwd.getpwnam("mandos").pw_gid
2436
uid = pwd.getpwnam(name).pw_uid
2437
gid = pwd.getpwnam(name).pw_gid
2438
break
1880
2439
except KeyError:
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
2440
continue
2441
else:
2442
uid = 65534
2443
gid = 65534
1887
2444
try:
1888
2445
os.setgid(gid)
1889
2446
os.setuid(uid)
1890
2447
except OSError as error:
1891
if error[0] != errno.EPERM:
2448
if error.errno != errno.EPERM:
1892
2449
raise error
1893
2450
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
1902
2451
if debug:
1903
2452
# Enable all possible GnuTLS debugging
1904
2453
1914
2463
.gnutls_global_set_log_function(debug_gnutls))
1915
2464
1916
2465
# Redirect stdin so all checkers get /dev/null
1917
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2466
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1918
2467
os.dup2(null, sys.stdin.fileno())
1919
2468
if null > 2:
1920
2469
os.close(null)
1921
else:
1922
# No console logging
1923
logger.removeHandler(console)
1924
2470
1925
2471
# Need to fork before connecting to D-Bus
1926
if not debug:
2472
if not foreground:
1927
2473
# Close all input and output, do double fork, etc.
1928
2474
daemon()
1929
2475
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
1930
2480
global main_loop
1931
2481
# From the Avahi example code
1932
DBusGMainLoop(set_as_default=True )
2482
DBusGMainLoop(set_as_default=True)
1933
2483
main_loop = gobject.MainLoop()
1934
2484
bus = dbus.SystemBus()
1935
2485
# End of Avahi example code
1936
2486
if use_dbus:
1937
2487
try:
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)
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))
1942
2493
except dbus.exceptions.NameExistsException as e:
1943
logger.error(unicode(e) + ", disabling D-Bus")
2494
logger.error("Disabling D-Bus:", exc_info=e)
1944
2495
use_dbus = False
1945
2496
server_settings["use_dbus"] = False
1946
2497
tcp_server.use_dbus = False
1947
2498
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1948
service = AvahiService(name = server_settings["servicename"],
1949
servicetype = "_mandos._tcp",
1950
protocol = protocol, bus = bus)
2499
service = AvahiServiceToSyslog(name =
2500
server_settings["servicename"],
2501
servicetype = "_mandos._tcp",
2502
protocol = protocol, bus = bus)
1951
2503
if server_settings["interface"]:
1952
2504
service.interface = (if_nametoindex
1953
2505
(str(server_settings["interface"])))
1957
2509
1958
2510
client_class = Client
1959
2511
if use_dbus:
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):
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))
1968
2583
try:
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()))
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
1978
2608
if not tcp_server.clients:
1979
2609
logger.warning("No clients defined")
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
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
1993
2621
del pidfilename
1994
1995
signal.signal(signal.SIGINT, signal.SIG_IGN)
1996
2622
1997
2623
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1998
2624
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1999
2625
2000
2626
if use_dbus:
2001
class MandosDBusService(dbus.service.Object):
2627
@alternate_dbus_interfaces({"se.recompile.Mandos":
2628
"se.bsnet.fukt.Mandos"})
2629
class MandosDBusService(DBusObjectWithProperties):
2002
2630
"""A D-Bus proxy object"""
2003
2631
def __init__(self):
2004
2632
dbus.service.Object.__init__(self, bus, "/")
2005
_interface = "se.bsnet.fukt.Mandos"
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"}
2006
2640
2007
2641
@dbus.service.signal(_interface, signature="o")
2008
2642
def ClientAdded(self, objpath):
2023
2657
def GetAllClients(self):
2024
2658
"D-Bus method"
2025
2659
return dbus.Array(c.dbus_object_path
2026
for c in tcp_server.clients)
2660
for c in
2661
tcp_server.clients.itervalues())
2027
2662
2028
2663
@dbus.service.method(_interface,
2029
2664
out_signature="a{oa{sv}}")
2031
2666
"D-Bus method"
2032
2667
return dbus.Dictionary(
2033
2668
((c.dbus_object_path, c.GetAll(""))
2034
for c in tcp_server.clients),
2669
for c in tcp_server.clients.itervalues()),
2035
2670
signature="oa{sv}")
2036
2671
2037
2672
@dbus.service.method(_interface, in_signature="o")
2038
2673
def RemoveClient(self, object_path):
2039
2674
"D-Bus method"
2040
for c in tcp_server.clients:
2675
for c in tcp_server.clients.itervalues():
2041
2676
if c.dbus_object_path == object_path:
2042
tcp_server.clients.remove(c)
2677
del tcp_server.clients[c.name]
2043
2678
c.remove_from_connection()
2044
2679
# Don't signal anything except ClientRemoved
2045
2680
c.disable(quiet=True)
2050
2685
2051
2686
del _interface
2052
2687
2053
class MandosDBusServiceTransitional(MandosDBusService):
2054
__metaclass__ = transitional_dbus_metaclass
2055
mandos_dbus_service = MandosDBusServiceTransitional()
2688
mandos_dbus_service = MandosDBusService()
2056
2689
2057
2690
def cleanup():
2058
2691
"Cleanup function; run on exit"
2059
2692
service.cleanup()
2060
2693
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
2061
2749
while tcp_server.clients:
2062
client = tcp_server.clients.pop()
2750
name, client = tcp_server.clients.popitem()
2063
2751
if use_dbus:
2064
2752
client.remove_from_connection()
2065
client.disable_hook = None
2066
2753
# Don't signal anything except ClientRemoved
2067
2754
client.disable(quiet=True)
2068
2755
if use_dbus:
2069
2756
# Emit D-Bus signal
2070
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2757
mandos_dbus_service.ClientRemoved(client
2758
.dbus_object_path,
2071
2759
client.name)
2760
client_settings.clear()
2072
2761
2073
2762
atexit.register(cleanup)
2074
2763
2075
for client in tcp_server.clients:
2764
for client in tcp_server.clients.itervalues():
2076
2765
if use_dbus:
2077
2766
# Emit D-Bus signal
2078
2767
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2079
client.enable()
2768
# Need to initiate checking of clients
2769
if client.enabled:
2770
client.init_checker()
2080
2771
2081
2772
tcp_server.enable()
2082
2773
tcp_server.server_activate()
2085
2776
service.port = tcp_server.socket.getsockname()[1]
2086
2777
if use_ipv6:
2087
2778
logger.info("Now listening on address %r, port %d,"
2088
" flowinfo %d, scope_id %d"
2089
% tcp_server.socket.getsockname())
2779
" flowinfo %d, scope_id %d",
2780
*tcp_server.socket.getsockname())
2090
2781
else: # IPv4
2091
logger.info("Now listening on address %r, port %d"
2092
% tcp_server.socket.getsockname())
2782
logger.info("Now listening on address %r, port %d",
2783
*tcp_server.socket.getsockname())
2093
2784
2094
2785
#service.interface = tcp_server.socket.getsockname()[3]
2095
2786
2098
2789
try:
2099
2790
service.activate()
2100
2791
except dbus.exceptions.DBusException as error:
2101
logger.critical("DBusException: %s", error)
2792
logger.critical("D-Bus Exception", exc_info=error)
2102
2793
cleanup()
2103
2794
sys.exit(1)
2104
2795
# End of Avahi example code
2111
2802
logger.debug("Starting main loop")
2112
2803
main_loop.run()
2113
2804
except AvahiError as error:
2114
logger.critical("AvahiError: %s", error)
2805
logger.critical("Avahi Error", exc_info=error)
2115
2806
cleanup()
2116
2807
sys.exit(1)
2117
2808
except KeyboardInterrupt:
2122
2813
# Must run before the D-Bus bus name gets deregistered
2123
2814
cleanup()
2124
2815
2125
2126
2816
if __name__ == '__main__':
2127
2817
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0