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
- 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
262
def rename(self):
279
263
"""Derived from the Avahi example code"""
280
264
if self.rename_count >= self.max_renames:
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))
269
self.name = unicode(self.server
270
.GetAlternativeServiceName(self.name))
287
271
logger.info("Changing Zeroconf service name to %r ...",
288
272
self.name)
289
273
self.remove()
290
274
try:
291
275
self.add()
292
276
except dbus.exceptions.DBusException as error:
293
logger.critical("D-Bus Exception", exc_info=error)
277
logger.critical("DBusException: %s", error)
294
278
self.cleanup()
295
279
os._exit(1)
296
280
self.rename_count += 1
297
298
281
def remove(self):
299
282
"""Derived from the Avahi example code"""
300
283
if self.entry_group_state_changed_match is not None:
302
285
self.entry_group_state_changed_match = None
303
286
if self.group is not None:
304
287
self.group.Reset()
305
306
288
def add(self):
307
289
"""Derived from the Avahi example code"""
308
290
self.remove()
325
307
dbus.UInt16(self.port),
326
308
avahi.string_array_to_txt_array(self.TXT))
327
309
self.group.Commit()
328
329
310
def entry_group_state_changed(self, state, error):
330
311
"""Derived from the Avahi example code"""
331
312
logger.debug("Avahi entry group state change: %i", state)
337
318
self.rename()
338
319
elif state == avahi.ENTRY_GROUP_FAILURE:
339
320
logger.critical("Avahi: Error in group state changed %s",
340
str(error))
341
raise AvahiGroupError("State changed: {!s}"
342
.format(error))
343
321
unicode(error))
322
raise AvahiGroupError("State changed: %s"
323
% unicode(error))
344
324
def cleanup(self):
345
325
"""Derived from the Avahi example code"""
346
326
if self.group is not None:
351
331
pass
352
332
self.group = None
353
333
self.remove()
354
355
334
def server_state_changed(self, state, error=None):
356
335
"""Derived from the Avahi example code"""
357
336
logger.debug("Avahi server state change: %i", state)
376
355
logger.debug("Unknown state: %r", state)
377
356
else:
378
357
logger.debug("Unknown state: %r: %r", state, error)
379
380
358
def activate(self):
381
359
"""Derived from the Avahi example code"""
382
360
if self.server is None:
389
367
self.server_state_changed)
390
368
self.server_state_changed(self.server.GetState())
391
369
392
393
370
class AvahiServiceToSyslog(AvahiService):
394
371
def rename(self):
395
372
"""Add the new name to the syslog messages"""
396
373
ret = AvahiService.rename(self)
397
374
syslogger.setFormatter(logging.Formatter
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
400
.format(self.name)))
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
377
% self.name))
401
378
return ret
402
379
403
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
404
386
class Client(object):
405
387
"""A representation of a client host served by this server.
406
388
407
389
Attributes:
408
approved: bool(); 'None' if not yet approved/disapproved
390
_approved: bool(); 'None' if not yet approved/disapproved
409
391
approval_delay: datetime.timedelta(); Time to wait for approval
410
392
approval_duration: datetime.timedelta(); Duration of one approval
411
393
checker: subprocess.Popen(); a running checker process used
429
411
interval: datetime.timedelta(); How often to start a new checker
430
412
last_approval_request: datetime.datetime(); (UTC) or None
431
413
last_checked_ok: datetime.datetime(); (UTC) or None
414
432
415
last_checker_status: integer between 0 and 255 reflecting exit
433
416
status of last checker. -1 reflects crashed
434
checker, -2 means no checker completed yet.
417
checker, or None.
435
418
last_enabled: datetime.datetime(); (UTC) or None
436
419
name: string; from the config file, used in log messages and
437
420
D-Bus identifiers
438
421
secret: bytestring; sent verbatim (over TLS) to client
439
422
timeout: datetime.timedelta(); How long from last_checked_ok
440
423
until this client is disabled
441
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
442
425
runtime_expansions: Allowed attributes for runtime expansion.
443
426
expires: datetime.datetime(); time (UTC) when a client will be
444
427
disabled, or None
445
server_settings: The server_settings dict from main()
446
428
"""
447
429
448
430
runtime_expansions = ("approval_delay", "approval_duration",
449
"created", "enabled", "expires",
450
"fingerprint", "host", "interval",
451
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
452
433
"last_enabled", "name", "timeout")
453
client_defaults = { "timeout": "PT5M",
454
"extended_timeout": "PT15M",
455
"interval": "PT2M",
456
"checker": "fping -q -- %%(host)s",
457
"host": "",
458
"approval_delay": "PT0S",
459
"approval_duration": "PT1S",
460
"approved_by_default": "True",
461
"enabled": "True",
462
}
463
464
@staticmethod
465
def config_parser(config):
466
"""Construct a new dict of client settings of this form:
467
{ client_name: {setting_name: value, ...}, ...}
468
with exceptions for any special settings as defined above.
469
NOTE: Must be a pure function. Must return the same result
470
value given the same arguments.
471
"""
472
settings = {}
473
for client_name in config.sections():
474
section = dict(config.items(client_name))
475
client = settings[client_name] = {}
476
477
client["host"] = section["host"]
478
# Reformat values from string types to Python types
479
client["approved_by_default"] = config.getboolean(
480
client_name, "approved_by_default")
481
client["enabled"] = config.getboolean(client_name,
482
"enabled")
483
484
client["fingerprint"] = (section["fingerprint"].upper()
485
.replace(" ", ""))
486
if "secret" in section:
487
client["secret"] = section["secret"].decode("base64")
488
elif "secfile" in section:
489
with open(os.path.expanduser(os.path.expandvars
490
(section["secfile"])),
491
"rb") as secfile:
492
client["secret"] = secfile.read()
493
else:
494
raise TypeError("No secret or secfile for section {}"
495
.format(section))
496
client["timeout"] = string_to_delta(section["timeout"])
497
client["extended_timeout"] = string_to_delta(
498
section["extended_timeout"])
499
client["interval"] = string_to_delta(section["interval"])
500
client["approval_delay"] = string_to_delta(
501
section["approval_delay"])
502
client["approval_duration"] = string_to_delta(
503
section["approval_duration"])
504
client["checker_command"] = section["checker"]
505
client["last_approval_request"] = None
506
client["last_checked_ok"] = None
507
client["last_checker_status"] = -2
508
509
return settings
510
511
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."""
512
454
self.name = name
513
if server_settings is None:
514
server_settings = {}
515
self.server_settings = server_settings
516
# adding all client settings
517
for setting, value in settings.items():
518
setattr(self, setting, value)
519
520
if self.enabled:
521
if not hasattr(self, "last_enabled"):
522
self.last_enabled = datetime.datetime.utcnow()
523
if not hasattr(self, "expires"):
524
self.expires = (datetime.datetime.utcnow()
525
+ self.timeout)
526
else:
527
self.last_enabled = None
528
self.expires = None
529
455
if config is None:
456
config = {}
530
457
logger.debug("Creating client %r", self.name)
531
458
# Uppercase and remove spaces from fingerprint for later
532
459
# comparison purposes with return value from the fingerprint()
533
460
# function
461
self.fingerprint = (config["fingerprint"].upper()
462
.replace(" ", ""))
534
463
logger.debug(" Fingerprint: %s", self.fingerprint)
535
self.created = settings.get("created",
536
datetime.datetime.utcnow())
537
538
# 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"])
539
488
self.checker = None
540
489
self.checker_initiator_tag = None
541
490
self.disable_initiator_tag = None
491
if self.enabled:
492
self.expires = datetime.datetime.utcnow() + self.timeout
493
else:
494
self.expires = None
542
495
self.checker_callback_tag = None
496
self.checker_command = config["checker"]
543
497
self.current_checker_command = None
544
self.approved = None
498
self._approved = None
499
self.approved_by_default = config.get("approved_by_default",
500
True)
545
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"])
546
506
self.changedstate = (multiprocessing_manager
547
507
.Condition(multiprocessing_manager
548
508
.Lock()))
568
528
if getattr(self, "enabled", False):
569
529
# Already enabled
570
530
return
531
self.send_changedstate()
571
532
self.expires = datetime.datetime.utcnow() + self.timeout
572
533
self.enabled = True
573
534
self.last_enabled = datetime.datetime.utcnow()
574
535
self.init_checker()
575
self.send_changedstate()
576
536
577
537
def disable(self, quiet=True):
578
538
"""Disable this client."""
579
539
if not getattr(self, "enabled", False):
580
540
return False
581
541
if not quiet:
542
self.send_changedstate()
543
if not quiet:
582
544
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", None) is not None:
545
if getattr(self, "disable_initiator_tag", False):
584
546
gobject.source_remove(self.disable_initiator_tag)
585
547
self.disable_initiator_tag = None
586
548
self.expires = None
587
if getattr(self, "checker_initiator_tag", None) is not None:
549
if getattr(self, "checker_initiator_tag", False):
588
550
gobject.source_remove(self.checker_initiator_tag)
589
551
self.checker_initiator_tag = None
590
552
self.stop_checker()
591
553
self.enabled = False
592
if not quiet:
593
self.send_changedstate()
594
554
# Do not run this again if called by a gobject.timeout_add
595
555
return False
596
556
600
560
def init_checker(self):
601
561
# Schedule a new checker to be started an 'interval' from now,
602
562
# and every interval from then on.
603
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
605
563
self.checker_initiator_tag = (gobject.timeout_add
606
(int(self.interval
607
.total_seconds() * 1000),
564
(self.interval_milliseconds(),
608
565
self.start_checker))
609
566
# Schedule a disable() when 'timeout' has passed
610
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
612
567
self.disable_initiator_tag = (gobject.timeout_add
613
(int(self.timeout
614
.total_seconds() * 1000),
615
self.disable))
568
(self.timeout_milliseconds(),
569
self.disable))
616
570
# Also start a new checker *right now*.
617
571
self.start_checker()
618
572
621
575
self.checker_callback_tag = None
622
576
self.checker = None
623
577
if os.WIFEXITED(condition):
624
self.last_checker_status = os.WEXITSTATUS(condition)
578
self.last_checker_status = os.WEXITSTATUS(condition)
625
579
if self.last_checker_status == 0:
626
580
logger.info("Checker for %(name)s succeeded",
627
581
vars(self))
634
588
logger.warning("Checker for %(name)s crashed?",
635
589
vars(self))
636
590
637
def checked_ok(self):
638
"""Assert that the client has been seen, alive and well."""
639
self.last_checked_ok = datetime.datetime.utcnow()
640
self.last_checker_status = 0
641
self.bump_timeout()
642
643
def bump_timeout(self, timeout=None):
644
"""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
"""
645
597
if timeout is None:
646
598
timeout = self.timeout
599
self.last_checked_ok = datetime.datetime.utcnow()
647
600
if self.disable_initiator_tag is not None:
648
601
gobject.source_remove(self.disable_initiator_tag)
649
self.disable_initiator_tag = None
650
602
if getattr(self, "enabled", False):
651
603
self.disable_initiator_tag = (gobject.timeout_add
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
604
(_timedelta_to_milliseconds
605
(timeout), self.disable))
654
606
self.expires = datetime.datetime.utcnow() + timeout
655
607
656
608
def need_approval(self):
662
614
If a checker already exists, leave it running and do
663
615
nothing."""
664
616
# The reason for not killing a running checker is that if we
665
# did that, and if a checker (for some reason) started running
666
# slowly and taking more than 'interval' time, then the client
667
# would inevitably timeout, since no checker would get a
668
# 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
669
621
# checkers alone, the checker would have to take more time
670
622
# than 'timeout' for the client to be disabled, which is as it
671
623
# should be.
673
625
# If a checker exists, make sure it is not a zombie
674
626
try:
675
627
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
676
except AttributeError:
677
pass
678
except OSError as error:
679
if error.errno != errno.ECHILD:
680
raise
628
except (AttributeError, OSError) as error:
629
if (isinstance(error, OSError)
630
and error.errno != errno.ECHILD):
631
raise error
681
632
else:
682
633
if pid:
683
634
logger.warning("Checker was a zombie")
686
637
self.current_checker_command)
687
638
# Start a new checker if needed
688
639
if self.checker is None:
689
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(str(getattr(self, attr)))
692
for attr in self.runtime_expansions }
693
640
try:
694
command = self.checker_command % escaped_attrs
695
except TypeError as error:
696
logger.error('Could not format string "%s"',
697
self.checker_command, exc_info=error)
698
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
699
659
self.current_checker_command = command
700
660
try:
701
661
logger.info("Starting checker %r for %s",
704
664
# in normal mode, that is already done by daemon(),
705
665
# and in debug mode we don't want to. (Stdin is
706
666
# always replaced by /dev/null.)
707
# The exception is when not debugging but nevertheless
708
# running in the foreground; use the previously
709
# created wnull.
710
popen_args = {}
711
if (not self.server_settings["debug"]
712
and self.server_settings["foreground"]):
713
popen_args.update({"stdout": wnull,
714
"stderr": wnull })
715
667
self.checker = subprocess.Popen(command,
716
668
close_fds=True,
717
shell=True, cwd="/",
718
**popen_args)
719
except OSError as error:
720
logger.error("Failed to start subprocess",
721
exc_info=error)
722
return True
723
self.checker_callback_tag = (gobject.child_watch_add
724
(self.checker.pid,
725
self.checker_callback,
726
data=command))
727
# The checker may have completed before the gobject
728
# watch was added. Check for this.
729
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.
730
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)
731
680
except OSError as error:
732
if error.errno == errno.ECHILD:
733
# This should never happen
734
logger.error("Child process vanished",
735
exc_info=error)
736
return True
737
raise
738
if pid:
739
gobject.source_remove(self.checker_callback_tag)
740
self.checker_callback(pid, status, command)
681
logger.error("Failed to start subprocess: %s",
682
error)
741
683
# Re-run this periodically if run by gobject.timeout_add
742
684
return True
743
685
750
692
return
751
693
logger.debug("Stopping checker for %(name)s", vars(self))
752
694
try:
753
self.checker.terminate()
695
os.kill(self.checker.pid, signal.SIGTERM)
754
696
#time.sleep(0.5)
755
697
#if self.checker.poll() is None:
756
# self.checker.kill()
698
# os.kill(self.checker.pid, signal.SIGKILL)
757
699
except OSError as error:
758
700
if error.errno != errno.ESRCH: # No such process
759
701
raise
776
718
# "Set" method, so we fail early here:
777
719
if byte_arrays and signature != "ay":
778
720
raise ValueError("Byte arrays not supported for non-'ay'"
779
" signature {!r}".format(signature))
721
" signature %r" % signature)
780
722
def decorator(func):
781
723
func._dbus_is_property = True
782
724
func._dbus_interface = dbus_interface
790
732
return decorator
791
733
792
734
793
def dbus_interface_annotations(dbus_interface):
794
"""Decorator for marking functions returning interface annotations
795
796
Usage:
797
798
@dbus_interface_annotations("org.example.Interface")
799
def _foo(self): # Function name does not matter
800
return {"org.freedesktop.DBus.Deprecated": "true",
801
"org.freedesktop.DBus.Property.EmitsChangedSignal":
802
"false"}
803
"""
804
def decorator(func):
805
func._dbus_is_interface = True
806
func._dbus_interface = dbus_interface
807
func._dbus_name = dbus_interface
808
return func
809
return decorator
810
811
812
def dbus_annotations(annotations):
813
"""Decorator to annotate D-Bus methods, signals or properties
814
Usage:
815
816
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
817
"org.freedesktop.DBus.Property."
818
"EmitsChangedSignal": "false"})
819
@dbus_service_property("org.example.Interface", signature="b",
820
access="r")
821
def Property_dbus_property(self):
822
return dbus.Boolean(False)
823
"""
824
def decorator(func):
825
func._dbus_annotations = annotations
826
return func
827
return decorator
828
829
830
735
class DBusPropertyException(dbus.exceptions.DBusException):
831
736
"""A base class for D-Bus property-related exceptions
832
737
"""
833
pass
738
def __unicode__(self):
739
return unicode(str(self))
740
834
741
835
742
class DBusPropertyAccessException(DBusPropertyException):
836
743
"""A property's access permissions disallows an operation.
853
760
"""
854
761
855
762
@staticmethod
856
def _is_dbus_thing(thing):
857
"""Returns a function testing if an attribute is a D-Bus thing
858
859
If called like _is_dbus_thing("method") it returns a function
860
suitable for use as predicate to inspect.getmembers().
861
"""
862
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
863
False)
763
def _is_dbus_property(obj):
764
return getattr(obj, "_dbus_is_property", False)
864
765
865
def _get_all_dbus_things(self, thing):
766
def _get_all_dbus_properties(self):
866
767
"""Returns a generator of (name, attribute) pairs
867
768
"""
868
return ((getattr(athing.__get__(self), "_dbus_name",
869
name),
870
athing.__get__(self))
769
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
871
770
for cls in self.__class__.__mro__
872
for name, athing in
873
inspect.getmembers(cls,
874
self._is_dbus_thing(thing)))
771
for name, prop in
772
inspect.getmembers(cls, self._is_dbus_property))
875
773
876
774
def _get_dbus_property(self, interface_name, property_name):
877
775
"""Returns a bound method if one exists which is a D-Bus
879
777
"""
880
778
for cls in self.__class__.__mro__:
881
779
for name, value in (inspect.getmembers
882
(cls,
883
self._is_dbus_thing("property"))):
780
(cls, self._is_dbus_property)):
884
781
if (value._dbus_name == property_name
885
782
and value._dbus_interface == interface_name):
886
783
return value.__get__(self)
914
811
# The byte_arrays option is not supported yet on
915
812
# signatures other than "ay".
916
813
if prop._dbus_signature != "ay":
917
raise ValueError("Byte arrays not supported for non-"
918
"'ay' signature {!r}"
919
.format(prop._dbus_signature))
920
value = dbus.ByteArray(b''.join(chr(byte)
921
for byte in value))
814
raise ValueError
815
value = dbus.ByteArray(''.join(unichr(byte)
816
for byte in value))
922
817
prop(value)
923
818
924
819
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
930
825
Note: Will not include properties with access="write".
931
826
"""
932
827
properties = {}
933
for name, prop in self._get_all_dbus_things("property"):
828
for name, prop in self._get_all_dbus_properties():
934
829
if (interface_name
935
830
and interface_name != prop._dbus_interface):
936
831
# Interface non-empty but did not match
946
841
value.variant_level+1)
947
842
return dbus.Dictionary(properties, signature="sv")
948
843
949
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
950
def PropertiesChanged(self, interface_name, changed_properties,
951
invalidated_properties):
952
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
953
standard.
954
"""
955
pass
956
957
844
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
958
845
out_signature="s",
959
846
path_keyword='object_path',
960
847
connection_keyword='connection')
961
848
def Introspect(self, object_path, connection):
962
"""Overloading of standard D-Bus method.
963
964
Inserts property tags and interface annotation tags.
849
"""Standard D-Bus method, overloaded to insert property tags.
965
850
"""
966
851
xmlstring = dbus.service.Object.Introspect(self, object_path,
967
852
connection)
974
859
e.setAttribute("access", prop._dbus_access)
975
860
return e
976
861
for if_tag in document.getElementsByTagName("interface"):
977
# Add property tags
978
862
for tag in (make_tag(document, name, prop)
979
863
for name, prop
980
in self._get_all_dbus_things("property")
864
in self._get_all_dbus_properties()
981
865
if prop._dbus_interface
982
866
== if_tag.getAttribute("name")):
983
867
if_tag.appendChild(tag)
984
# Add annotation tags
985
for typ in ("method", "signal", "property"):
986
for tag in if_tag.getElementsByTagName(typ):
987
annots = dict()
988
for name, prop in (self.
989
_get_all_dbus_things(typ)):
990
if (name == tag.getAttribute("name")
991
and prop._dbus_interface
992
== if_tag.getAttribute("name")):
993
annots.update(getattr
994
(prop,
995
"_dbus_annotations",
996
{}))
997
for name, value in annots.items():
998
ann_tag = document.createElement(
999
"annotation")
1000
ann_tag.setAttribute("name", name)
1001
ann_tag.setAttribute("value", value)
1002
tag.appendChild(ann_tag)
1003
# Add interface annotation tags
1004
for annotation, value in dict(
1005
itertools.chain.from_iterable(
1006
annotations().items()
1007
for name, annotations in
1008
self._get_all_dbus_things("interface")
1009
if name == if_tag.getAttribute("name")
1010
)).items():
1011
ann_tag = document.createElement("annotation")
1012
ann_tag.setAttribute("name", annotation)
1013
ann_tag.setAttribute("value", value)
1014
if_tag.appendChild(ann_tag)
1015
868
# Add the names to the return values for the
1016
869
# "org.freedesktop.DBus.Properties" methods
1017
870
if (if_tag.getAttribute("name")
1032
885
except (AttributeError, xml.dom.DOMException,
1033
886
xml.parsers.expat.ExpatError) as error:
1034
887
logger.error("Failed to override Introspection method",
1035
exc_info=error)
888
error)
1036
889
return xmlstring
1037
890
1038
891
1039
def datetime_to_dbus(dt, variant_level=0):
892
def datetime_to_dbus (dt, variant_level=0):
1040
893
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1041
894
if dt is None:
1042
895
return dbus.String("", variant_level = variant_level)
1044
897
variant_level=variant_level)
1045
898
1046
899
1047
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1048
"""A class decorator; applied to a subclass of
1049
dbus.service.Object, it will add alternate D-Bus attributes with
1050
interface names according to the "alt_interface_names" mapping.
1051
Usage:
1052
1053
@alternate_dbus_interfaces({"org.example.Interface":
1054
"net.example.AlternateInterface"})
1055
class SampleDBusObject(dbus.service.Object):
1056
@dbus.service.method("org.example.Interface")
1057
def SampleDBusMethod():
1058
pass
1059
1060
The above "SampleDBusMethod" on "SampleDBusObject" will be
1061
reachable via two interfaces: "org.example.Interface" and
1062
"net.example.AlternateInterface", the latter of which will have
1063
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1064
"true", unless "deprecate" is passed with a False value.
1065
1066
This works for methods and signals, and also for D-Bus properties
1067
(from DBusObjectWithProperties) and interfaces (from the
1068
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.
1069
904
"""
1070
def wrapper(cls):
1071
for orig_interface_name, alt_interface_name in (
1072
alt_interface_names.items()):
1073
attr = {}
1074
interface_names = set()
1075
# Go though all attributes of the class
1076
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):
1077
912
# Ignore non-D-Bus attributes, and D-Bus attributes
1078
913
# with the wrong interface name
1079
914
if (not hasattr(attribute, "_dbus_interface")
1080
915
or not attribute._dbus_interface
1081
.startswith(orig_interface_name)):
916
.startswith("se.recompile.Mandos")):
1082
917
continue
1083
918
# Create an alternate D-Bus interface name based on
1084
919
# the current name
1085
920
alt_interface = (attribute._dbus_interface
1086
.replace(orig_interface_name,
1087
alt_interface_name))
1088
interface_names.add(alt_interface)
921
.replace("se.recompile.Mandos",
922
"se.bsnet.fukt.Mandos"))
1089
923
# Is this a D-Bus signal?
1090
924
if getattr(attribute, "_dbus_is_signal", False):
1091
# Extract the original non-method undecorated
1092
# function by black magic
925
# Extract the original non-method function by
926
# black magic
1093
927
nonmethod_func = (dict(
1094
928
zip(attribute.func_code.co_freevars,
1095
929
attribute.__closure__))["func"]
1106
940
nonmethod_func.func_name,
1107
941
nonmethod_func.func_defaults,
1108
942
nonmethod_func.func_closure)))
1109
# Copy annotations, if any
1110
try:
1111
new_function._dbus_annotations = (
1112
dict(attribute._dbus_annotations))
1113
except AttributeError:
1114
pass
1115
943
# Define a creator of a function to call both the
1116
# original and alternate functions, so both the
1117
# original and alternate signals gets sent when
1118
# the function is called
944
# old and new functions, so both the old and new
945
# signals gets sent when the function is called
1119
946
def fixscope(func1, func2):
1120
947
"""This function is a scope container to pass
1121
948
func1 and func2 to the "call_both" function
1128
955
return call_both
1129
956
# Create the "call_both" function and add it to
1130
957
# the class
1131
attr[attrname] = fixscope(attribute, new_function)
958
attr[attrname] = fixscope(attribute,
959
new_function)
1132
960
# Is this a D-Bus method?
1133
961
elif getattr(attribute, "_dbus_is_method", False):
1134
962
# Create a new, but exactly alike, function
1145
973
attribute.func_name,
1146
974
attribute.func_defaults,
1147
975
attribute.func_closure)))
1148
# Copy annotations, if any
1149
try:
1150
attr[attrname]._dbus_annotations = (
1151
dict(attribute._dbus_annotations))
1152
except AttributeError:
1153
pass
1154
976
# Is this a D-Bus property?
1155
977
elif getattr(attribute, "_dbus_is_property", False):
1156
978
# Create a new, but exactly alike, function
1170
992
attribute.func_name,
1171
993
attribute.func_defaults,
1172
994
attribute.func_closure)))
1173
# Copy annotations, if any
1174
try:
1175
attr[attrname]._dbus_annotations = (
1176
dict(attribute._dbus_annotations))
1177
except AttributeError:
1178
pass
1179
# Is this a D-Bus interface?
1180
elif getattr(attribute, "_dbus_is_interface", False):
1181
# Create a new, but exactly alike, function
1182
# object. Decorate it to be a new D-Bus interface
1183
# with the alternate D-Bus interface name. Add it
1184
# to the class.
1185
attr[attrname] = (dbus_interface_annotations
1186
(alt_interface)
1187
(types.FunctionType
1188
(attribute.func_code,
1189
attribute.func_globals,
1190
attribute.func_name,
1191
attribute.func_defaults,
1192
attribute.func_closure)))
1193
if deprecate:
1194
# Deprecate all alternate interfaces
1195
iname="_AlternateDBusNames_interface_annotation{}"
1196
for interface_name in interface_names:
1197
@dbus_interface_annotations(interface_name)
1198
def func(self):
1199
return { "org.freedesktop.DBus.Deprecated":
1200
"true" }
1201
# Find an unused name
1202
for aname in (iname.format(i)
1203
for i in itertools.count()):
1204
if aname not in attr:
1205
attr[aname] = func
1206
break
1207
if interface_names:
1208
# Replace the class with a new subclass of it with
1209
# methods, signals, etc. as created above.
1210
cls = type(b"{}Alternate".format(cls.__name__),
1211
(cls,), attr)
1212
return cls
1213
return wrapper
1214
1215
1216
@alternate_dbus_interfaces({"se.recompile.Mandos":
1217
"se.bsnet.fukt.Mandos"})
995
return type.__new__(mcs, name, bases, attr)
996
997
1218
998
class ClientDBus(Client, DBusObjectWithProperties):
1219
999
"""A Client class using D-Bus
1220
1000
1226
1006
runtime_expansions = (Client.runtime_expansions
1227
1007
+ ("dbus_object_path",))
1228
1008
1229
_interface = "se.recompile.Mandos.Client"
1230
1231
1009
# dbus.service.Object doesn't use super(), so we can't either.
1232
1010
1233
1011
def __init__(self, bus = None, *args, **kwargs):
1234
1012
self.bus = bus
1235
1013
Client.__init__(self, *args, **kwargs)
1014
1015
self._approvals_pending = 0
1236
1016
# Only now, when this client is initialized, can it show up on
1237
1017
# the D-Bus
1238
client_object_name = str(self.name).translate(
1018
client_object_name = unicode(self.name).translate(
1239
1019
{ord("."): ord("_"),
1240
1020
ord("-"): ord("_")})
1241
1021
self.dbus_object_path = (dbus.ObjectPath
1242
1022
("/clients/" + client_object_name))
1243
1023
DBusObjectWithProperties.__init__(self, self.bus,
1244
1024
self.dbus_object_path)
1245
1025
1246
1026
def notifychangeproperty(transform_func,
1247
1027
dbus_name, type_func=lambda x: x,
1248
variant_level=1, invalidate_only=False,
1249
_interface=_interface):
1028
variant_level=1):
1250
1029
""" Modify a variable so that it's a property which announces
1251
1030
its changes to DBus.
1252
1031
1257
1036
to the D-Bus. Default: no transform
1258
1037
variant_level: D-Bus variant level. Default: 1
1259
1038
"""
1260
attrname = "_{}".format(dbus_name)
1039
attrname = "_{0}".format(dbus_name)
1261
1040
def setter(self, value):
1262
1041
if hasattr(self, "dbus_object_path"):
1263
1042
if (not hasattr(self, attrname) or
1264
1043
type_func(getattr(self, attrname, None))
1265
1044
!= type_func(value)):
1266
if invalidate_only:
1267
self.PropertiesChanged(_interface,
1268
dbus.Dictionary(),
1269
dbus.Array
1270
((dbus_name,)))
1271
else:
1272
dbus_value = transform_func(type_func(value),
1273
variant_level
1274
=variant_level)
1275
self.PropertyChanged(dbus.String(dbus_name),
1276
dbus_value)
1277
self.PropertiesChanged(_interface,
1278
dbus.Dictionary({
1279
dbus.String(dbus_name):
1280
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)
1281
1050
setattr(self, attrname, value)
1282
1051
1283
1052
return property(lambda self: getattr(self, attrname), setter)
1284
1053
1054
1285
1055
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1286
1056
approvals_pending = notifychangeproperty(dbus.Boolean,
1287
1057
"ApprovalPending",
1294
1064
checker is not None)
1295
1065
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1296
1066
"LastCheckedOK")
1297
last_checker_status = notifychangeproperty(dbus.Int16,
1298
"LastCheckerStatus")
1299
1067
last_approval_request = notifychangeproperty(
1300
1068
datetime_to_dbus, "LastApprovalRequest")
1301
1069
approved_by_default = notifychangeproperty(dbus.Boolean,
1302
1070
"ApprovedByDefault")
1303
approval_delay = notifychangeproperty(dbus.UInt64,
1071
approval_delay = notifychangeproperty(dbus.UInt16,
1304
1072
"ApprovalDelay",
1305
1073
type_func =
1306
lambda td: td.total_seconds()
1307
* 1000)
1074
_timedelta_to_milliseconds)
1308
1075
approval_duration = notifychangeproperty(
1309
dbus.UInt64, "ApprovalDuration",
1310
type_func = lambda td: td.total_seconds() * 1000)
1076
dbus.UInt16, "ApprovalDuration",
1077
type_func = _timedelta_to_milliseconds)
1311
1078
host = notifychangeproperty(dbus.String, "Host")
1312
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1313
type_func = lambda td:
1314
td.total_seconds() * 1000)
1079
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1080
type_func =
1081
_timedelta_to_milliseconds)
1315
1082
extended_timeout = notifychangeproperty(
1316
dbus.UInt64, "ExtendedTimeout",
1317
type_func = lambda td: td.total_seconds() * 1000)
1318
interval = notifychangeproperty(dbus.UInt64,
1083
dbus.UInt16, "ExtendedTimeout",
1084
type_func = _timedelta_to_milliseconds)
1085
interval = notifychangeproperty(dbus.UInt16,
1319
1086
"Interval",
1320
1087
type_func =
1321
lambda td: td.total_seconds()
1322
* 1000)
1088
_timedelta_to_milliseconds)
1323
1089
checker_command = notifychangeproperty(dbus.String, "Checker")
1324
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1325
invalidate_only=True)
1326
1090
1327
1091
del notifychangeproperty
1328
1092
1355
1119
*args, **kwargs)
1356
1120
1357
1121
def start_checker(self, *args, **kwargs):
1358
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
1359
1127
r = Client.start_checker(self, *args, **kwargs)
1360
1128
# Only if new checker process was started
1361
1129
if (self.checker is not None
1365
1133
return r
1366
1134
1367
1135
def _reset_approved(self):
1368
self.approved = None
1136
self._approved = None
1369
1137
return False
1370
1138
1371
1139
def approve(self, value=True):
1372
self.approved = value
1373
gobject.timeout_add(int(self.approval_duration.total_seconds()
1374
* 1000), self._reset_approved)
1375
1140
self.send_changedstate()
1141
self._approved = value
1142
gobject.timeout_add(_timedelta_to_milliseconds
1143
(self.approval_duration),
1144
self._reset_approved)
1145
1376
1146
1377
1147
## D-Bus methods, signals & properties
1378
1379
## Interfaces
1148
_interface = "se.recompile.Mandos.Client"
1380
1149
1381
1150
## Signals
1382
1151
1393
1162
pass
1394
1163
1395
1164
# PropertyChanged - signal
1396
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1397
1165
@dbus.service.signal(_interface, signature="sv")
1398
1166
def PropertyChanged(self, property, value):
1399
1167
"D-Bus signal"
1420
1188
"D-Bus signal"
1421
1189
return self.need_approval()
1422
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
1423
1199
## Methods
1424
1200
1425
1201
# Approve - method
1475
1251
access="readwrite")
1476
1252
def ApprovalDelay_dbus_property(self, value=None):
1477
1253
if value is None: # get
1478
return dbus.UInt64(self.approval_delay.total_seconds()
1479
* 1000)
1254
return dbus.UInt64(self.approval_delay_milliseconds())
1480
1255
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1481
1256
1482
1257
# ApprovalDuration - property
1484
1259
access="readwrite")
1485
1260
def ApprovalDuration_dbus_property(self, value=None):
1486
1261
if value is None: # get
1487
return dbus.UInt64(self.approval_duration.total_seconds()
1488
* 1000)
1262
return dbus.UInt64(_timedelta_to_milliseconds(
1263
self.approval_duration))
1489
1264
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1490
1265
1491
1266
# Name - property
1504
1279
def Host_dbus_property(self, value=None):
1505
1280
if value is None: # get
1506
1281
return dbus.String(self.host)
1507
self.host = str(value)
1282
self.host = value
1508
1283
1509
1284
# Created - property
1510
1285
@dbus_service_property(_interface, signature="s", access="read")
1536
1311
return
1537
1312
return datetime_to_dbus(self.last_checked_ok)
1538
1313
1539
# LastCheckerStatus - property
1540
@dbus_service_property(_interface, signature="n",
1541
access="read")
1542
def LastCheckerStatus_dbus_property(self):
1543
return dbus.Int16(self.last_checker_status)
1544
1545
1314
# Expires - property
1546
1315
@dbus_service_property(_interface, signature="s", access="read")
1547
1316
def Expires_dbus_property(self):
1557
1326
access="readwrite")
1558
1327
def Timeout_dbus_property(self, value=None):
1559
1328
if value is None: # get
1560
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1561
old_timeout = self.timeout
1329
return dbus.UInt64(self.timeout_milliseconds())
1562
1330
self.timeout = datetime.timedelta(0, 0, 0, value)
1563
# Reschedule disabling
1564
if self.enabled:
1565
now = datetime.datetime.utcnow()
1566
self.expires += self.timeout - old_timeout
1567
if self.expires <= now:
1568
# The timeout has passed
1569
self.disable()
1570
else:
1571
if (getattr(self, "disable_initiator_tag", None)
1572
is None):
1573
return
1574
gobject.source_remove(self.disable_initiator_tag)
1575
self.disable_initiator_tag = (
1576
gobject.timeout_add(
1577
int((self.expires - now).total_seconds()
1578
* 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))
1579
1351
1580
1352
# ExtendedTimeout - property
1581
1353
@dbus_service_property(_interface, signature="t",
1582
1354
access="readwrite")
1583
1355
def ExtendedTimeout_dbus_property(self, value=None):
1584
1356
if value is None: # get
1585
return dbus.UInt64(self.extended_timeout.total_seconds()
1586
* 1000)
1357
return dbus.UInt64(self.extended_timeout_milliseconds())
1587
1358
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1588
1359
1589
1360
# Interval - property
1591
1362
access="readwrite")
1592
1363
def Interval_dbus_property(self, value=None):
1593
1364
if value is None: # get
1594
return dbus.UInt64(self.interval.total_seconds() * 1000)
1365
return dbus.UInt64(self.interval_milliseconds())
1595
1366
self.interval = datetime.timedelta(0, 0, 0, value)
1596
1367
if getattr(self, "checker_initiator_tag", None) is None:
1597
1368
return
1608
1379
def Checker_dbus_property(self, value=None):
1609
1380
if value is None: # get
1610
1381
return dbus.String(self.checker_command)
1611
self.checker_command = str(value)
1382
self.checker_command = value
1612
1383
1613
1384
# CheckerRunning - property
1614
1385
@dbus_service_property(_interface, signature="b",
1630
1401
@dbus_service_property(_interface, signature="ay",
1631
1402
access="write", byte_arrays=True)
1632
1403
def Secret_dbus_property(self, value):
1633
self.secret = bytes(value)
1404
self.secret = str(value)
1634
1405
1635
1406
del _interface
1636
1407
1643
1414
raise KeyError()
1644
1415
1645
1416
def __getattribute__(self, name):
1646
if name == '_pipe':
1417
if(name == '_pipe'):
1647
1418
return super(ProxyClient, self).__getattribute__(name)
1648
1419
self._pipe.send(('getattr', name))
1649
1420
data = self._pipe.recv()
1656
1427
return func
1657
1428
1658
1429
def __setattr__(self, name, value):
1659
if name == '_pipe':
1430
if(name == '_pipe'):
1660
1431
return super(ProxyClient, self).__setattr__(name, value)
1661
1432
self._pipe.send(('setattr', name, value))
1662
1433
1663
1434
1435
class ClientDBusTransitional(ClientDBus):
1436
__metaclass__ = AlternateDBusNamesMetaclass
1437
1438
1664
1439
class ClientHandler(socketserver.BaseRequestHandler, object):
1665
1440
"""A class to handle client connections.
1666
1441
1670
1445
def handle(self):
1671
1446
with contextlib.closing(self.server.child_pipe) as child_pipe:
1672
1447
logger.info("TCP connection from: %s",
1673
str(self.client_address))
1448
unicode(self.client_address))
1674
1449
logger.debug("Pipe FD: %d",
1675
1450
self.server.child_pipe.fileno())
1676
1451
1702
1477
logger.debug("Protocol version: %r", line)
1703
1478
try:
1704
1479
if int(line.strip().split()[0]) > 1:
1705
raise RuntimeError(line)
1480
raise RuntimeError
1706
1481
except (ValueError, IndexError, RuntimeError) as error:
1707
1482
logger.error("Unknown protocol version: %s", error)
1708
1483
return
1727
1502
logger.warning("Bad certificate: %s", error)
1728
1503
return
1729
1504
logger.debug("Fingerprint: %s", fpr)
1505
if self.server.use_dbus:
1506
# Emit D-Bus signal
1507
client.NewRequest(str(self.client_address))
1730
1508
1731
1509
try:
1732
1510
client = ProxyClient(child_pipe, fpr,
1748
1526
client.Rejected("Disabled")
1749
1527
return
1750
1528
1751
if client.approved or not client.approval_delay:
1529
if client._approved or not client.approval_delay:
1752
1530
#We are approved or approval is disabled
1753
1531
break
1754
elif client.approved is None:
1532
elif client._approved is None:
1755
1533
logger.info("Client %s needs approval",
1756
1534
client.name)
1757
1535
if self.server.use_dbus:
1758
1536
# Emit D-Bus signal
1759
1537
client.NeedApproval(
1760
client.approval_delay.total_seconds()
1761
* 1000, client.approved_by_default)
1538
client.approval_delay_milliseconds(),
1539
client.approved_by_default)
1762
1540
else:
1763
1541
logger.warning("Client %s was not approved",
1764
1542
client.name)
1770
1548
#wait until timeout or approved
1771
1549
time = datetime.datetime.now()
1772
1550
client.changedstate.acquire()
1773
client.changedstate.wait(delay.total_seconds())
1551
(client.changedstate.wait
1552
(float(client._timedelta_to_milliseconds(delay)
1553
/ 1000)))
1774
1554
client.changedstate.release()
1775
1555
time2 = datetime.datetime.now()
1776
1556
if (time2 - time) >= delay:
1792
1572
try:
1793
1573
sent = session.send(client.secret[sent_size:])
1794
1574
except gnutls.errors.GNUTLSError as error:
1795
logger.warning("gnutls send failed",
1796
exc_info=error)
1575
logger.warning("gnutls send failed")
1797
1576
return
1798
1577
logger.debug("Sent: %d, remaining: %d",
1799
1578
sent, len(client.secret)
1802
1581
1803
1582
logger.info("Sending secret to %s", client.name)
1804
1583
# bump the timeout using extended_timeout
1805
client.bump_timeout(client.extended_timeout)
1584
client.checked_ok(client.extended_timeout)
1806
1585
if self.server.use_dbus:
1807
1586
# Emit D-Bus signal
1808
1587
client.GotSecret()
1813
1592
try:
1814
1593
session.bye()
1815
1594
except gnutls.errors.GNUTLSError as error:
1816
logger.warning("GnuTLS bye failed",
1817
exc_info=error)
1595
logger.warning("GnuTLS bye failed")
1818
1596
1819
1597
@staticmethod
1820
1598
def peer_certificate(session):
1885
1663
def sub_process_main(self, request, address):
1886
1664
try:
1887
1665
self.finish_request(request, address)
1888
except Exception:
1666
except:
1889
1667
self.handle_error(request, address)
1890
1668
self.close_request(request)
1891
1669
1892
1670
def process_request(self, request, address):
1893
1671
"""Start a new process to process the request."""
1894
1672
proc = multiprocessing.Process(target = self.sub_process_main,
1895
args = (request, address))
1673
args = (request,
1674
address))
1896
1675
proc.start()
1897
1676
return proc
1898
1677
1913
1692
1914
1693
def add_pipe(self, parent_pipe, proc):
1915
1694
"""Dummy function; override as necessary"""
1916
raise NotImplementedError()
1695
raise NotImplementedError
1917
1696
1918
1697
1919
1698
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1926
1705
use_ipv6: Boolean; to use IPv6 or not
1927
1706
"""
1928
1707
def __init__(self, server_address, RequestHandlerClass,
1929
interface=None, use_ipv6=True, socketfd=None):
1930
"""If socketfd is set, use that file descriptor instead of
1931
creating a new one with socket.socket().
1932
"""
1708
interface=None, use_ipv6=True):
1933
1709
self.interface = interface
1934
1710
if use_ipv6:
1935
1711
self.address_family = socket.AF_INET6
1936
if socketfd is not None:
1937
# Save the file descriptor
1938
self.socketfd = socketfd
1939
# Save the original socket.socket() function
1940
self.socket_socket = socket.socket
1941
# To implement --socket, we monkey patch socket.socket.
1942
#
1943
# (When socketserver.TCPServer is a new-style class, we
1944
# could make self.socket into a property instead of monkey
1945
# patching socket.socket.)
1946
#
1947
# Create a one-time-only replacement for socket.socket()
1948
@functools.wraps(socket.socket)
1949
def socket_wrapper(*args, **kwargs):
1950
# Restore original function so subsequent calls are
1951
# not affected.
1952
socket.socket = self.socket_socket
1953
del self.socket_socket
1954
# This time only, return a new socket object from the
1955
# saved file descriptor.
1956
return socket.fromfd(self.socketfd, *args, **kwargs)
1957
# Replace socket.socket() function with wrapper
1958
socket.socket = socket_wrapper
1959
# The socketserver.TCPServer.__init__ will call
1960
# socket.socket(), which might be our replacement,
1961
# socket_wrapper(), if socketfd was set.
1962
1712
socketserver.TCPServer.__init__(self, server_address,
1963
1713
RequestHandlerClass)
1964
1965
1714
def server_bind(self):
1966
1715
"""This overrides the normal server_bind() function
1967
1716
to bind to an interface if one was specified, and also NOT to
1975
1724
try:
1976
1725
self.socket.setsockopt(socket.SOL_SOCKET,
1977
1726
SO_BINDTODEVICE,
1978
(self.interface + "\0")
1979
.encode("utf-8"))
1727
str(self.interface
1728
+ '\0'))
1980
1729
except socket.error as error:
1981
if error.errno == errno.EPERM:
1982
logger.error("No permission to bind to"
1983
" interface %s", self.interface)
1984
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:
1985
1735
logger.error("SO_BINDTODEVICE not available;"
1986
1736
" cannot bind to interface %s",
1987
1737
self.interface)
1988
elif error.errno == errno.ENODEV:
1989
logger.error("Interface %s does not exist,"
1990
" cannot bind", self.interface)
1991
1738
else:
1992
1739
raise
1993
1740
# Only bind(2) the socket if we really need to.
1996
1743
if self.address_family == socket.AF_INET6:
1997
1744
any_address = "::" # in6addr_any
1998
1745
else:
1999
any_address = "0.0.0.0" # INADDR_ANY
1746
any_address = socket.INADDR_ANY
2000
1747
self.server_address = (any_address,
2001
1748
self.server_address[1])
2002
1749
elif not self.server_address[1]:
2023
1770
"""
2024
1771
def __init__(self, server_address, RequestHandlerClass,
2025
1772
interface=None, use_ipv6=True, clients=None,
2026
gnutls_priority=None, use_dbus=True, socketfd=None):
1773
gnutls_priority=None, use_dbus=True):
2027
1774
self.enabled = False
2028
1775
self.clients = clients
2029
1776
if self.clients is None:
2033
1780
IPv6_TCPServer.__init__(self, server_address,
2034
1781
RequestHandlerClass,
2035
1782
interface = interface,
2036
use_ipv6 = use_ipv6,
2037
socketfd = socketfd)
1783
use_ipv6 = use_ipv6)
2038
1784
def server_activate(self):
2039
1785
if self.enabled:
2040
1786
return socketserver.TCPServer.server_activate(self)
2053
1799
2054
1800
def handle_ipc(self, source, condition, parent_pipe=None,
2055
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)
2056
1816
# error, or the other end of multiprocessing.Pipe has closed
2057
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1817
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2058
1818
# Wait for other process to exit
2059
1819
proc.join()
2060
1820
return False
2118
1878
return True
2119
1879
2120
1880
2121
def rfc3339_duration_to_delta(duration):
2122
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2123
2124
>>> rfc3339_duration_to_delta("P7D")
2125
datetime.timedelta(7)
2126
>>> rfc3339_duration_to_delta("PT60S")
2127
datetime.timedelta(0, 60)
2128
>>> rfc3339_duration_to_delta("PT60M")
2129
datetime.timedelta(0, 3600)
2130
>>> rfc3339_duration_to_delta("PT24H")
2131
datetime.timedelta(1)
2132
>>> rfc3339_duration_to_delta("P1W")
2133
datetime.timedelta(7)
2134
>>> rfc3339_duration_to_delta("PT5M30S")
2135
datetime.timedelta(0, 330)
2136
>>> rfc3339_duration_to_delta("P1DT3M20S")
2137
datetime.timedelta(1, 200)
2138
"""
2139
2140
# Parsing an RFC 3339 duration with regular expressions is not
2141
# possible - there would have to be multiple places for the same
2142
# values, like seconds. The current code, while more esoteric, is
2143
# cleaner without depending on a parsing library. If Python had a
2144
# built-in library for parsing we would use it, but we'd like to
2145
# avoid excessive use of external libraries.
2146
2147
# New type for defining tokens, syntax, and semantics all-in-one
2148
Token = collections.namedtuple("Token",
2149
("regexp", # To match token; if
2150
# "value" is not None,
2151
# must have a "group"
2152
# containing digits
2153
"value", # datetime.timedelta or
2154
# None
2155
"followers")) # Tokens valid after
2156
# this token
2157
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2158
# the "duration" ABNF definition in RFC 3339, Appendix A.
2159
token_end = Token(re.compile(r"$"), None, frozenset())
2160
token_second = Token(re.compile(r"(\d+)S"),
2161
datetime.timedelta(seconds=1),
2162
frozenset((token_end,)))
2163
token_minute = Token(re.compile(r"(\d+)M"),
2164
datetime.timedelta(minutes=1),
2165
frozenset((token_second, token_end)))
2166
token_hour = Token(re.compile(r"(\d+)H"),
2167
datetime.timedelta(hours=1),
2168
frozenset((token_minute, token_end)))
2169
token_time = Token(re.compile(r"T"),
2170
None,
2171
frozenset((token_hour, token_minute,
2172
token_second)))
2173
token_day = Token(re.compile(r"(\d+)D"),
2174
datetime.timedelta(days=1),
2175
frozenset((token_time, token_end)))
2176
token_month = Token(re.compile(r"(\d+)M"),
2177
datetime.timedelta(weeks=4),
2178
frozenset((token_day, token_end)))
2179
token_year = Token(re.compile(r"(\d+)Y"),
2180
datetime.timedelta(weeks=52),
2181
frozenset((token_month, token_end)))
2182
token_week = Token(re.compile(r"(\d+)W"),
2183
datetime.timedelta(weeks=1),
2184
frozenset((token_end,)))
2185
token_duration = Token(re.compile(r"P"), None,
2186
frozenset((token_year, token_month,
2187
token_day, token_time,
2188
token_week)))
2189
# Define starting values
2190
value = datetime.timedelta() # Value so far
2191
found_token = None
2192
followers = frozenset((token_duration,)) # Following valid tokens
2193
s = duration # String left to parse
2194
# Loop until end token is found
2195
while found_token is not token_end:
2196
# Search for any currently valid tokens
2197
for token in followers:
2198
match = token.regexp.match(s)
2199
if match is not None:
2200
# Token found
2201
if token.value is not None:
2202
# Value found, parse digits
2203
factor = int(match.group(1), 10)
2204
# Add to value so far
2205
value += factor * token.value
2206
# Strip token from string
2207
s = token.regexp.sub("", s, 1)
2208
# Go to found token
2209
found_token = token
2210
# Set valid next tokens
2211
followers = found_token.followers
2212
break
2213
else:
2214
# No currently valid tokens were found
2215
raise ValueError("Invalid RFC 3339 duration")
2216
# End token found
2217
return value
2218
2219
2220
1881
def string_to_delta(interval):
2221
1882
"""Parse a string and return a datetime.timedelta
2222
1883
2233
1894
>>> string_to_delta('5m 30s')
2234
1895
datetime.timedelta(0, 330)
2235
1896
"""
2236
2237
try:
2238
return rfc3339_duration_to_delta(interval)
2239
except ValueError:
2240
pass
2241
2242
1897
timevalue = datetime.timedelta(0)
2243
1898
for s in interval.split():
2244
1899
try:
2245
suffix = s[-1]
1900
suffix = unicode(s[-1])
2246
1901
value = int(s[:-1])
2247
1902
if suffix == "d":
2248
1903
delta = datetime.timedelta(value)
2255
1910
elif suffix == "w":
2256
1911
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2257
1912
else:
2258
raise ValueError("Unknown suffix {!r}"
2259
.format(suffix))
2260
except IndexError as e:
1913
raise ValueError("Unknown suffix %r" % suffix)
1914
except (ValueError, IndexError) as e:
2261
1915
raise ValueError(*(e.args))
2262
1916
timevalue += delta
2263
1917
return timevalue
2276
1930
sys.exit()
2277
1931
if not noclose:
2278
1932
# Close all standard open file descriptors
2279
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1933
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2280
1934
if not stat.S_ISCHR(os.fstat(null).st_mode):
2281
raise OSError(errno.ENODEV, "{} not a character device"
2282
.format(os.devnull))
1935
raise OSError(errno.ENODEV,
1936
"%s not a character device"
1937
% os.path.devnull)
2283
1938
os.dup2(null, sys.stdin.fileno())
2284
1939
os.dup2(null, sys.stdout.fileno())
2285
1940
os.dup2(null, sys.stderr.fileno())
2294
1949
2295
1950
parser = argparse.ArgumentParser()
2296
1951
parser.add_argument("-v", "--version", action="version",
2297
version = "%(prog)s {}".format(version),
1952
version = "%%(prog)s %s" % version,
2298
1953
help="show version number and exit")
2299
1954
parser.add_argument("-i", "--interface", metavar="IF",
2300
1955
help="Bind to interface IF")
2306
1961
help="Run self-test")
2307
1962
parser.add_argument("--debug", action="store_true",
2308
1963
help="Debug mode; run in foreground and log"
2309
" to terminal", default=None)
1964
" to terminal")
2310
1965
parser.add_argument("--debuglevel", metavar="LEVEL",
2311
1966
help="Debug level for stdout output")
2312
1967
parser.add_argument("--priority", help="GnuTLS"
2319
1974
" files")
2320
1975
parser.add_argument("--no-dbus", action="store_false",
2321
1976
dest="use_dbus", help="Do not provide D-Bus"
2322
" system bus interface", default=None)
1977
" system bus interface")
2323
1978
parser.add_argument("--no-ipv6", action="store_false",
2324
dest="use_ipv6", help="Do not use IPv6",
2325
default=None)
1979
dest="use_ipv6", help="Do not use IPv6")
2326
1980
parser.add_argument("--no-restore", action="store_false",
2327
1981
dest="restore", help="Do not restore stored"
2328
" state", default=None)
2329
parser.add_argument("--socket", type=int,
2330
help="Specify a file descriptor to a network"
2331
" socket to use instead of creating one")
1982
" state")
2332
1983
parser.add_argument("--statedir", metavar="DIR",
2333
1984
help="Directory to save/restore state in")
2334
parser.add_argument("--foreground", action="store_true",
2335
help="Run in foreground", default=None)
2336
parser.add_argument("--no-zeroconf", action="store_false",
2337
dest="zeroconf", help="Do not use Zeroconf",
2338
default=None)
2339
1985
2340
1986
options = parser.parse_args()
2341
1987
2342
1988
if options.check:
2343
1989
import doctest
2344
fail_count, test_count = doctest.testmod()
2345
sys.exit(os.EX_OK if fail_count == 0 else 1)
1990
doctest.testmod()
1991
sys.exit()
2346
1992
2347
1993
# Default values for config file for server-global settings
2348
1994
server_defaults = { "interface": "",
2350
1996
"port": "",
2351
1997
"debug": "False",
2352
1998
"priority":
2353
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1999
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2354
2000
"servicename": "Mandos",
2355
2001
"use_dbus": "True",
2356
2002
"use_ipv6": "True",
2357
2003
"debuglevel": "",
2358
2004
"restore": "True",
2359
"socket": "",
2360
"statedir": "/var/lib/mandos",
2361
"foreground": "False",
2362
"zeroconf": "True",
2005
"statedir": "/var/lib/mandos"
2363
2006
}
2364
2007
2365
2008
# Parse config file for server-global settings
2370
2013
# Convert the SafeConfigParser object to a dict
2371
2014
server_settings = server_config.defaults()
2372
2015
# Use the appropriate methods on the non-string config options
2373
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2016
for option in ("debug", "use_dbus", "use_ipv6"):
2374
2017
server_settings[option] = server_config.getboolean("DEFAULT",
2375
2018
option)
2376
2019
if server_settings["port"]:
2377
2020
server_settings["port"] = server_config.getint("DEFAULT",
2378
2021
"port")
2379
if server_settings["socket"]:
2380
server_settings["socket"] = server_config.getint("DEFAULT",
2381
"socket")
2382
# Later, stdin will, and stdout and stderr might, be dup'ed
2383
# over with an opened os.devnull. But we don't want this to
2384
# happen with a supplied network socket.
2385
if 0 <= server_settings["socket"] <= 2:
2386
server_settings["socket"] = os.dup(server_settings
2387
["socket"])
2388
2022
del server_config
2389
2023
2390
2024
# Override the settings from the config file with command line
2392
2026
for option in ("interface", "address", "port", "debug",
2393
2027
"priority", "servicename", "configdir",
2394
2028
"use_dbus", "use_ipv6", "debuglevel", "restore",
2395
"statedir", "socket", "foreground", "zeroconf"):
2029
"statedir"):
2396
2030
value = getattr(options, option)
2397
2031
if value is not None:
2398
2032
server_settings[option] = value
2399
2033
del options
2400
2034
# Force all strings to be unicode
2401
2035
for option in server_settings.keys():
2402
if isinstance(server_settings[option], bytes):
2403
server_settings[option] = (server_settings[option]
2404
.decode("utf-8"))
2405
# Force all boolean options to be boolean
2406
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2407
"foreground", "zeroconf"):
2408
server_settings[option] = bool(server_settings[option])
2409
# Debug implies foreground
2410
if server_settings["debug"]:
2411
server_settings["foreground"] = True
2036
if type(server_settings[option]) is str:
2037
server_settings[option] = unicode(server_settings[option])
2412
2038
# Now we have our good server settings in "server_settings"
2413
2039
2414
2040
##################################################################
2415
2041
2416
if (not server_settings["zeroconf"] and
2417
not (server_settings["port"]
2418
or server_settings["socket"] != "")):
2419
parser.error("Needs port or socket to work without"
2420
" Zeroconf")
2421
2422
2042
# For convenience
2423
2043
debug = server_settings["debug"]
2424
2044
debuglevel = server_settings["debuglevel"]
2426
2046
use_ipv6 = server_settings["use_ipv6"]
2427
2047
stored_state_path = os.path.join(server_settings["statedir"],
2428
2048
stored_state_file)
2429
foreground = server_settings["foreground"]
2430
zeroconf = server_settings["zeroconf"]
2431
2049
2432
2050
if debug:
2433
initlogger(debug, logging.DEBUG)
2051
initlogger(logging.DEBUG)
2434
2052
else:
2435
2053
if not debuglevel:
2436
initlogger(debug)
2054
initlogger()
2437
2055
else:
2438
2056
level = getattr(logging, debuglevel.upper())
2439
initlogger(debug, level)
2057
initlogger(level)
2440
2058
2441
2059
if server_settings["servicename"] != "Mandos":
2442
2060
syslogger.setFormatter(logging.Formatter
2443
('Mandos ({}) [%(process)d]:'
2444
' %(levelname)s: %(message)s'
2445
.format(server_settings
2446
["servicename"])))
2061
('Mandos (%s) [%%(process)d]:'
2062
' %%(levelname)s: %%(message)s'
2063
% server_settings["servicename"]))
2447
2064
2448
2065
# Parse config file with clients
2449
client_config = configparser.SafeConfigParser(Client
2450
.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)
2451
2075
client_config.read(os.path.join(server_settings["configdir"],
2452
2076
"clients.conf"))
2453
2077
2454
2078
global mandos_dbus_service
2455
2079
mandos_dbus_service = None
2456
2080
2457
socketfd = None
2458
if server_settings["socket"] != "":
2459
socketfd = server_settings["socket"]
2460
2081
tcp_server = MandosServer((server_settings["address"],
2461
2082
server_settings["port"]),
2462
2083
ClientHandler,
2465
2086
use_ipv6=use_ipv6,
2466
2087
gnutls_priority=
2467
2088
server_settings["priority"],
2468
use_dbus=use_dbus,
2469
socketfd=socketfd)
2470
if not foreground:
2471
pidfilename = "/run/mandos.pid"
2472
if not os.path.isdir("/run/."):
2473
pidfilename = "/var/run/mandos.pid"
2474
pidfile = None
2089
use_dbus=use_dbus)
2090
if not debug:
2091
pidfilename = "/var/run/mandos.pid"
2475
2092
try:
2476
2093
pidfile = open(pidfilename, "w")
2477
except IOError as e:
2478
logger.error("Could not open file %r", pidfilename,
2479
exc_info=e)
2094
except IOError:
2095
logger.error("Could not open file %r", pidfilename)
2480
2096
2481
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:
2482
2101
try:
2483
uid = pwd.getpwnam(name).pw_uid
2484
gid = pwd.getpwnam(name).pw_gid
2485
break
2102
uid = pwd.getpwnam("mandos").pw_uid
2103
gid = pwd.getpwnam("mandos").pw_gid
2486
2104
except KeyError:
2487
continue
2488
else:
2489
uid = 65534
2490
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
2491
2111
try:
2492
2112
os.setgid(gid)
2493
2113
os.setuid(uid)
2494
2114
except OSError as error:
2495
if error.errno != errno.EPERM:
2496
raise
2115
if error[0] != errno.EPERM:
2116
raise error
2497
2117
2498
2118
if debug:
2499
2119
# Enable all possible GnuTLS debugging
2510
2130
.gnutls_global_set_log_function(debug_gnutls))
2511
2131
2512
2132
# Redirect stdin so all checkers get /dev/null
2513
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2133
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2514
2134
os.dup2(null, sys.stdin.fileno())
2515
2135
if null > 2:
2516
2136
os.close(null)
2137
else:
2138
# No console logging
2139
logger.removeHandler(console)
2517
2140
2518
2141
# Need to fork before connecting to D-Bus
2519
if not foreground:
2142
if not debug:
2520
2143
# Close all input and output, do double fork, etc.
2521
2144
daemon()
2522
2145
2523
# multiprocessing will use threads, so before we use gobject we
2524
# need to inform gobject that threads will be used.
2525
gobject.threads_init()
2526
2527
2146
global main_loop
2528
2147
# From the Avahi example code
2529
DBusGMainLoop(set_as_default=True)
2148
DBusGMainLoop(set_as_default=True )
2530
2149
main_loop = gobject.MainLoop()
2531
2150
bus = dbus.SystemBus()
2532
2151
# End of Avahi example code
2538
2157
("se.bsnet.fukt.Mandos", bus,
2539
2158
do_not_queue=True))
2540
2159
except dbus.exceptions.NameExistsException as e:
2541
logger.error("Disabling D-Bus:", exc_info=e)
2160
logger.error(unicode(e) + ", disabling D-Bus")
2542
2161
use_dbus = False
2543
2162
server_settings["use_dbus"] = False
2544
2163
tcp_server.use_dbus = False
2545
if zeroconf:
2546
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2547
service = AvahiServiceToSyslog(name =
2548
server_settings["servicename"],
2549
servicetype = "_mandos._tcp",
2550
protocol = protocol, bus = bus)
2551
if server_settings["interface"]:
2552
service.interface = (if_nametoindex
2553
(server_settings["interface"]
2554
.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"])))
2555
2172
2556
2173
global multiprocessing_manager
2557
2174
multiprocessing_manager = multiprocessing.Manager()
2558
2175
2559
2176
client_class = Client
2560
2177
if use_dbus:
2561
client_class = functools.partial(ClientDBus, bus = bus)
2562
2563
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
2564
2204
old_client_settings = {}
2565
clients_data = {}
2566
2567
# This is used to redirect stdout and stderr for checker processes
2568
global wnull
2569
wnull = open(os.devnull, "w") # A writable /dev/null
2570
# Only used if server is running in foreground but not in debug
2571
# mode
2572
if debug or not foreground:
2573
wnull.close()
2205
clients_data = []
2574
2206
2575
2207
# Get client data and settings from last running state.
2576
2208
if server_settings["restore"]:
2580
2212
(stored_state))
2581
2213
os.remove(stored_state_path)
2582
2214
except IOError as e:
2583
if e.errno == errno.ENOENT:
2584
logger.warning("Could not load persistent state: {}"
2585
.format(os.strerror(e.errno)))
2586
else:
2587
logger.critical("Could not load persistent state:",
2588
exc_info=e)
2215
logger.warning("Could not load persistent state: {0}"
2216
.format(e))
2217
if e.errno != errno.ENOENT:
2589
2218
raise
2590
except EOFError as e:
2591
logger.warning("Could not load persistent state: "
2592
"EOFError:", exc_info=e)
2593
2219
2594
with PGPEngine() as pgp:
2595
for client_name, client in clients_data.items():
2596
# Skip removed clients
2597
if client_name not in client_settings:
2598
continue
2220
with Crypto() as crypt:
2221
for client in clients_data:
2222
client_name = client["name"]
2599
2223
2600
2224
# Decide which value to use after restoring saved state.
2601
2225
# We have three different values: Old config file,
2610
2234
if (name != "secret" and
2611
2235
value != old_client_settings[client_name]
2612
2236
[name]):
2613
client[name] = value
2237
setattr(client, name, value)
2614
2238
except KeyError:
2615
2239
pass
2616
2240
2617
2241
# Clients who has passed its expire date can still be
2618
# enabled if its last checker was successful. Clients
2619
# whose checker succeeded before we stored its state is
2620
# assumed to have successfully run all checkers during
2621
# downtime.
2622
if client["enabled"]:
2623
if datetime.datetime.utcnow() >= client["expires"]:
2624
if not client["last_checked_ok"]:
2625
logger.warning(
2626
"disabling client {} - Client never "
2627
"performed a successful checker"
2628
.format(client_name))
2629
client["enabled"] = False
2630
elif client["last_checker_status"] != 0:
2631
logger.warning(
2632
"disabling client {} - Client last"
2633
" checker failed with error code {}"
2634
.format(client_name,
2635
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:
2636
2250
client["enabled"] = False
2637
2251
else:
2638
2252
client["expires"] = (datetime.datetime
2639
2253
.utcnow()
2640
2254
+ client["timeout"])
2641
logger.debug("Last checker succeeded,"
2642
" keeping {} enabled"
2643
.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
2644
2284
try:
2645
client["secret"] = (
2646
pgp.decrypt(client["encrypted_secret"],
2647
client_settings[client_name]
2648
["secret"]))
2649
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:
2650
2291
# If decryption fails, we use secret from new settings
2651
logger.debug("Failed to decrypt {} old secret"
2652
.format(client_name))
2653
client["secret"] = (
2292
tcp_server.clients[client_name].secret = (
2654
2293
client_settings[client_name]["secret"])
2655
2294
2656
# Add/remove clients based on new changes made to config
2657
for client_name in (set(old_client_settings)
2658
- set(client_settings)):
2659
del clients_data[client_name]
2660
for client_name in (set(client_settings)
2661
- set(old_client_settings)):
2662
clients_data[client_name] = client_settings[client_name]
2663
2664
# Create all client objects
2665
for client_name, client in clients_data.items():
2666
tcp_server.clients[client_name] = client_class(
2667
name = client_name, settings = client,
2668
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]))
2669
2304
2670
2305
if not tcp_server.clients:
2671
2306
logger.warning("No clients defined")
2672
2673
if not foreground:
2674
if pidfile is not None:
2675
try:
2676
with pidfile:
2677
pid = os.getpid()
2678
pidfile.write("{}\n".format(pid).encode("utf-8"))
2679
except IOError:
2680
logger.error("Could not write to file %r with PID %d",
2681
pidfilename, pid)
2682
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
2683
2320
del pidfilename
2321
2322
signal.signal(signal.SIGINT, signal.SIG_IGN)
2684
2323
2685
2324
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2686
2325
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2687
2326
2688
2327
if use_dbus:
2689
@alternate_dbus_interfaces({"se.recompile.Mandos":
2690
"se.bsnet.fukt.Mandos"})
2691
class MandosDBusService(DBusObjectWithProperties):
2328
class MandosDBusService(dbus.service.Object):
2692
2329
"""A D-Bus proxy object"""
2693
2330
def __init__(self):
2694
2331
dbus.service.Object.__init__(self, bus, "/")
2695
2332
_interface = "se.recompile.Mandos"
2696
2333
2697
@dbus_interface_annotations(_interface)
2698
def _foo(self):
2699
return { "org.freedesktop.DBus.Property"
2700
".EmitsChangedSignal":
2701
"false"}
2702
2703
2334
@dbus.service.signal(_interface, signature="o")
2704
2335
def ClientAdded(self, objpath):
2705
2336
"D-Bus signal"
2727
2358
def GetAllClientsWithProperties(self):
2728
2359
"D-Bus method"
2729
2360
return dbus.Dictionary(
2730
{ c.dbus_object_path: c.GetAll("")
2731
for c in tcp_server.clients.itervalues() },
2361
((c.dbus_object_path, c.GetAll(""))
2362
for c in tcp_server.clients.itervalues()),
2732
2363
signature="oa{sv}")
2733
2364
2734
2365
@dbus.service.method(_interface, in_signature="o")
2747
2378
2748
2379
del _interface
2749
2380
2750
mandos_dbus_service = MandosDBusService()
2381
class MandosDBusServiceTransitional(MandosDBusService):
2382
__metaclass__ = AlternateDBusNamesMetaclass
2383
mandos_dbus_service = MandosDBusServiceTransitional()
2751
2384
2752
2385
def cleanup():
2753
2386
"Cleanup function; run on exit"
2754
if zeroconf:
2755
service.cleanup()
2387
service.cleanup()
2756
2388
2757
2389
multiprocessing.active_children()
2758
wnull.close()
2759
2390
if not (tcp_server.clients or client_settings):
2760
2391
return
2761
2392
2762
2393
# Store client before exiting. Secrets are encrypted with key
2763
2394
# based on what config file has. If config file is
2764
2395
# removed/edited, old secret will thus be unrecovable.
2765
clients = {}
2766
with PGPEngine() as pgp:
2396
clients = []
2397
with Crypto() as crypt:
2767
2398
for client in tcp_server.clients.itervalues():
2768
2399
key = client_settings[client.name]["secret"]
2769
client.encrypted_secret = pgp.encrypt(client.secret,
2770
key)
2400
client.encrypted_secret = crypt.encrypt(client.secret,
2401
key)
2771
2402
client_dict = {}
2772
2403
2773
# A list of attributes that can not be pickled
2774
# + secret.
2775
exclude = { "bus", "changedstate", "secret",
2776
"checker", "server_settings" }
2404
# A list of attributes that will not be stored when
2405
# shutting down.
2406
exclude = set(("bus", "changedstate", "secret"))
2777
2407
for name, typ in (inspect.getmembers
2778
2408
(dbus.service.Object)):
2779
2409
exclude.add(name)
2784
2414
if attr not in exclude:
2785
2415
client_dict[attr] = getattr(client, attr)
2786
2416
2787
clients[client.name] = client_dict
2417
clients.append(client_dict)
2788
2418
del client_settings[client.name]["secret"]
2789
2419
2790
2420
try:
2791
with (tempfile.NamedTemporaryFile
2792
(mode='wb', suffix=".pickle", prefix='clients-',
2793
dir=os.path.dirname(stored_state_path),
2794
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:
2795
2424
pickle.dump((clients, client_settings), stored_state)
2796
tempname=stored_state.name
2797
os.rename(tempname, stored_state_path)
2798
2425
except (IOError, OSError) as e:
2799
if not debug:
2800
try:
2801
os.remove(tempname)
2802
except NameError:
2803
pass
2804
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2805
logger.warning("Could not save persistent state: {}"
2806
.format(os.strerror(e.errno)))
2807
else:
2808
logger.warning("Could not save persistent state:",
2809
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):
2810
2429
raise
2811
2430
2812
2431
# Delete all clients, and settings from config
2837
2456
tcp_server.server_activate()
2838
2457
2839
2458
# Find out what port we got
2840
if zeroconf:
2841
service.port = tcp_server.socket.getsockname()[1]
2459
service.port = tcp_server.socket.getsockname()[1]
2842
2460
if use_ipv6:
2843
2461
logger.info("Now listening on address %r, port %d,"
2844
" flowinfo %d, scope_id %d",
2845
*tcp_server.socket.getsockname())
2462
" flowinfo %d, scope_id %d"
2463
% tcp_server.socket.getsockname())
2846
2464
else: # IPv4
2847
logger.info("Now listening on address %r, port %d",
2848
*tcp_server.socket.getsockname())
2465
logger.info("Now listening on address %r, port %d"
2466
% tcp_server.socket.getsockname())
2849
2467
2850
2468
#service.interface = tcp_server.socket.getsockname()[3]
2851
2469
2852
2470
try:
2853
if zeroconf:
2854
# From the Avahi example code
2855
try:
2856
service.activate()
2857
except dbus.exceptions.DBusException as error:
2858
logger.critical("D-Bus Exception", exc_info=error)
2859
cleanup()
2860
sys.exit(1)
2861
# 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
2862
2479
2863
2480
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2864
2481
lambda *args, **kwargs:
2868
2485
logger.debug("Starting main loop")
2869
2486
main_loop.run()
2870
2487
except AvahiError as error:
2871
logger.critical("Avahi Error", exc_info=error)
2488
logger.critical("AvahiError: %s", error)
2872
2489
cleanup()
2873
2490
sys.exit(1)
2874
2491
except KeyboardInterrupt:
2879
2496
# Must run before the D-Bus bus name gets deregistered
2880
2497
cleanup()
2881
2498
2499
2882
2500
if __name__ == '__main__':
2883
2501
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0