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