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