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 550
- compare with another revision
- download diff
- download tarball
- view history from revision 550
- Committer: Teddy Hogeborn
- Date: 2012-01-01 20:45:53 UTC
- Revision ID: teddy@recompile.se-20120101204553-f1zlty873gswtf5n
* README: Hint that the intro(8mandos) manual page is in the server
package.
package.
- files removed:
- debian/mandos-client.examples
- debian/upstream
- 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-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
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
94
version = "1.6.9"
88
version = "1.5.0"
95
89
stored_state_file = "clients.pickle"
96
90
97
91
logger = logging.getLogger()
98
syslogger = None
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
99
95
100
96
try:
101
97
if_nametoindex = (ctypes.cdll.LoadLibrary
107
103
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
108
104
with contextlib.closing(socket.socket()) as s:
109
105
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
110
struct.pack(b"16s16x", interface))
111
interface_index = struct.unpack("I", ifreq[16:20])[0]
106
struct.pack(str("16s16x"),
107
interface))
108
interface_index = struct.unpack(str("I"),
109
ifreq[16:20])[0]
112
110
return interface_index
113
111
114
112
115
113
def initlogger(debug, level=logging.WARNING):
116
114
"""init logger and add loglevel"""
117
115
118
global syslogger
119
syslogger = (logging.handlers.SysLogHandler
120
(facility =
121
logging.handlers.SysLogHandler.LOG_DAEMON,
122
address = "/dev/log"))
123
116
syslogger.setFormatter(logging.Formatter
124
117
('Mandos [%(process)d]: %(levelname)s:'
125
118
' %(message)s'))
143
136
class PGPEngine(object):
144
137
"""A simple class for OpenPGP symmetric encryption & decryption"""
145
138
def __init__(self):
139
self.gnupg = GnuPGInterface.GnuPG()
146
140
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
147
self.gnupgargs = ['--batch',
148
'--home', self.tempdir,
149
'--force-mdc',
150
'--quiet',
151
'--no-use-agent']
141
self.gnupg = GnuPGInterface.GnuPG()
142
self.gnupg.options.meta_interactive = False
143
self.gnupg.options.homedir = self.tempdir
144
self.gnupg.options.extra_args.extend(['--force-mdc',
145
'--quiet',
146
'--no-use-agent'])
152
147
153
148
def __enter__(self):
154
149
return self
155
150
156
def __exit__(self, exc_type, exc_value, traceback):
151
def __exit__ (self, exc_type, exc_value, traceback):
157
152
self._cleanup()
158
153
return False
159
154
176
171
def password_encode(self, password):
177
172
# Passphrase can not be empty and can not contain newlines or
178
173
# 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
174
return b"mandos" + binascii.hexlify(password)
186
175
187
176
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)
177
self.gnupg.passphrase = self.password_encode(password)
178
with open(os.devnull) as devnull:
179
try:
180
proc = self.gnupg.run(['--symmetric'],
181
create_fhs=['stdin', 'stdout'],
182
attach_fhs={'stderr': devnull})
183
with contextlib.closing(proc.handles['stdin']) as f:
184
f.write(data)
185
with contextlib.closing(proc.handles['stdout']) as f:
186
ciphertext = f.read()
187
proc.wait()
188
except IOError as e:
189
raise PGPError(e)
190
self.gnupg.passphrase = None
203
191
return ciphertext
204
192
205
193
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)
194
self.gnupg.passphrase = self.password_encode(password)
195
with open(os.devnull) as devnull:
196
try:
197
proc = self.gnupg.run(['--decrypt'],
198
create_fhs=['stdin', 'stdout'],
199
attach_fhs={'stderr': devnull})
200
with contextlib.closing(proc.handles['stdin'] ) as f:
201
f.write(data)
202
with contextlib.closing(proc.handles['stdout']) as f:
203
decrypted_plaintext = f.read()
204
proc.wait()
205
except IOError as e:
206
raise PGPError(e)
207
self.gnupg.passphrase = None
222
208
return decrypted_plaintext
223
209
224
210
211
225
212
class AvahiError(Exception):
226
213
def __init__(self, value, *args, **kwargs):
227
214
self.value = value
228
return super(AvahiError, self).__init__(value, *args,
229
**kwargs)
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
230
218
231
219
class AvahiServiceError(AvahiError):
232
220
pass
243
231
Used to optionally bind to the specified interface.
244
232
name: string; Example: 'Mandos'
245
233
type: string; Example: '_mandos._tcp'.
246
See <https://www.iana.org/assignments/service-names-port-numbers>
234
See <http://www.dns-sd.org/ServiceTypes.html>
247
235
port: integer; what port to announce
248
236
TXT: list of strings; TXT record for the service
249
237
domain: string; Domain to publish on, default to .local if empty.
255
243
server: D-Bus Server
256
244
bus: dbus.SystemBus()
257
245
"""
258
259
246
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
247
servicetype = None, port = None, TXT = None,
261
248
domain = "", host = "", max_renames = 32768,
274
261
self.server = None
275
262
self.bus = bus
276
263
self.entry_group_state_changed_match = None
277
278
def rename(self, remove=True):
264
def rename(self):
279
265
"""Derived from the Avahi example code"""
280
266
if self.rename_count >= self.max_renames:
281
267
logger.critical("No suitable Zeroconf service name found"
282
268
" after %i retries, exiting.",
283
269
self.rename_count)
284
270
raise AvahiServiceError("Too many renames")
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
287
self.rename_count += 1
271
self.name = unicode(self.server
272
.GetAlternativeServiceName(self.name))
288
273
logger.info("Changing Zeroconf service name to %r ...",
289
274
self.name)
290
if remove:
291
self.remove()
275
self.remove()
292
276
try:
293
277
self.add()
294
278
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
279
logger.critical("DBusException: %s", error)
280
self.cleanup()
281
os._exit(1)
282
self.rename_count += 1
304
283
def remove(self):
305
284
"""Derived from the Avahi example code"""
306
285
if self.entry_group_state_changed_match is not None:
308
287
self.entry_group_state_changed_match = None
309
288
if self.group is not None:
310
289
self.group.Reset()
311
312
290
def add(self):
313
291
"""Derived from the Avahi example code"""
314
292
self.remove()
331
309
dbus.UInt16(self.port),
332
310
avahi.string_array_to_txt_array(self.TXT))
333
311
self.group.Commit()
334
335
312
def entry_group_state_changed(self, state, error):
336
313
"""Derived from the Avahi example code"""
337
314
logger.debug("Avahi entry group state change: %i", state)
343
320
self.rename()
344
321
elif state == avahi.ENTRY_GROUP_FAILURE:
345
322
logger.critical("Avahi: Error in group state changed %s",
346
str(error))
347
raise AvahiGroupError("State changed: {!s}"
348
.format(error))
349
323
unicode(error))
324
raise AvahiGroupError("State changed: %s"
325
% unicode(error))
350
326
def cleanup(self):
351
327
"""Derived from the Avahi example code"""
352
328
if self.group is not None:
357
333
pass
358
334
self.group = None
359
335
self.remove()
360
361
336
def server_state_changed(self, state, error=None):
362
337
"""Derived from the Avahi example code"""
363
338
logger.debug("Avahi server state change: %i", state)
382
357
logger.debug("Unknown state: %r", state)
383
358
else:
384
359
logger.debug("Unknown state: %r: %r", state, error)
385
386
360
def activate(self):
387
361
"""Derived from the Avahi example code"""
388
362
if self.server is None:
395
369
self.server_state_changed)
396
370
self.server_state_changed(self.server.GetState())
397
371
398
399
372
class AvahiServiceToSyslog(AvahiService):
400
def rename(self, *args, **kwargs):
373
def rename(self):
401
374
"""Add the new name to the syslog messages"""
402
ret = AvahiService.rename(self, *args, **kwargs)
375
ret = AvahiService.rename(self)
403
376
syslogger.setFormatter(logging.Formatter
404
('Mandos ({}) [%(process)d]:'
405
' %(levelname)s: %(message)s'
406
.format(self.name)))
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
379
% self.name))
407
380
return ret
408
381
409
382
def timedelta_to_milliseconds(td):
383
"Convert a datetime.timedelta() to milliseconds"
384
return ((td.days * 24 * 60 * 60 * 1000)
385
+ (td.seconds * 1000)
386
+ (td.microseconds // 1000))
387
410
388
class Client(object):
411
389
"""A representation of a client host served by this server.
412
390
437
415
last_checked_ok: datetime.datetime(); (UTC) or None
438
416
last_checker_status: integer between 0 and 255 reflecting exit
439
417
status of last checker. -1 reflects crashed
440
checker, -2 means no checker completed yet.
418
checker, or None.
441
419
last_enabled: datetime.datetime(); (UTC) or None
442
420
name: string; from the config file, used in log messages and
443
421
D-Bus identifiers
444
422
secret: bytestring; sent verbatim (over TLS) to client
445
423
timeout: datetime.timedelta(); How long from last_checked_ok
446
424
until this client is disabled
447
extended_timeout: extra long timeout when secret has been sent
425
extended_timeout: extra long timeout when password has been sent
448
426
runtime_expansions: Allowed attributes for runtime expansion.
449
427
expires: datetime.datetime(); time (UTC) when a client will be
450
428
disabled, or None
451
server_settings: The server_settings dict from main()
452
429
"""
453
430
454
431
runtime_expansions = ("approval_delay", "approval_duration",
455
"created", "enabled", "expires",
456
"fingerprint", "host", "interval",
457
"last_approval_request", "last_checked_ok",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
458
434
"last_enabled", "name", "timeout")
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
461
"interval": "PT2M",
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
437
"interval": "2m",
462
438
"checker": "fping -q -- %%(host)s",
463
439
"host": "",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
466
442
"approved_by_default": "True",
467
443
"enabled": "True",
468
444
}
469
445
446
def timeout_milliseconds(self):
447
"Return the 'timeout' attribute in milliseconds"
448
return timedelta_to_milliseconds(self.timeout)
449
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
453
454
def interval_milliseconds(self):
455
"Return the 'interval' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.interval)
457
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
460
470
461
@staticmethod
471
462
def config_parser(config):
472
463
"""Construct a new dict of client settings of this form:
497
488
"rb") as secfile:
498
489
client["secret"] = secfile.read()
499
490
else:
500
raise TypeError("No secret or secfile for section {}"
501
.format(section))
491
raise TypeError("No secret or secfile for section %s"
492
% section)
502
493
client["timeout"] = string_to_delta(section["timeout"])
503
494
client["extended_timeout"] = string_to_delta(
504
495
section["extended_timeout"])
510
501
client["checker_command"] = section["checker"]
511
502
client["last_approval_request"] = None
512
503
client["last_checked_ok"] = None
513
client["last_checker_status"] = -2
504
client["last_checker_status"] = None
514
505
515
506
return settings
516
517
def __init__(self, settings, name = None, server_settings=None):
507
508
509
def __init__(self, settings, name = None):
510
"""Note: the 'checker' key in 'config' sets the
511
'checker_command' attribute and *not* the 'checker'
512
attribute."""
518
513
self.name = name
519
if server_settings is None:
520
server_settings = {}
521
self.server_settings = server_settings
522
514
# adding all client settings
523
for setting, value in settings.items():
515
for setting, value in settings.iteritems():
524
516
setattr(self, setting, value)
525
517
526
518
if self.enabled:
532
524
else:
533
525
self.last_enabled = None
534
526
self.expires = None
535
527
536
528
logger.debug("Creating client %r", self.name)
537
529
# Uppercase and remove spaces from fingerprint for later
538
530
# comparison purposes with return value from the fingerprint()
540
532
logger.debug(" Fingerprint: %s", self.fingerprint)
541
533
self.created = settings.get("created",
542
534
datetime.datetime.utcnow())
543
535
544
536
# attributes specific for this server instance
545
537
self.checker = None
546
538
self.checker_initiator_tag = None
574
566
if getattr(self, "enabled", False):
575
567
# Already enabled
576
568
return
569
self.send_changedstate()
577
570
self.expires = datetime.datetime.utcnow() + self.timeout
578
571
self.enabled = True
579
572
self.last_enabled = datetime.datetime.utcnow()
580
573
self.init_checker()
581
self.send_changedstate()
582
574
583
575
def disable(self, quiet=True):
584
576
"""Disable this client."""
585
577
if not getattr(self, "enabled", False):
586
578
return False
587
579
if not quiet:
580
self.send_changedstate()
581
if not quiet:
588
582
logger.info("Disabling client %s", self.name)
589
if getattr(self, "disable_initiator_tag", None) is not None:
583
if getattr(self, "disable_initiator_tag", False):
590
584
gobject.source_remove(self.disable_initiator_tag)
591
585
self.disable_initiator_tag = None
592
586
self.expires = None
593
if getattr(self, "checker_initiator_tag", None) is not None:
587
if getattr(self, "checker_initiator_tag", False):
594
588
gobject.source_remove(self.checker_initiator_tag)
595
589
self.checker_initiator_tag = None
596
590
self.stop_checker()
597
591
self.enabled = False
598
if not quiet:
599
self.send_changedstate()
600
592
# Do not run this again if called by a gobject.timeout_add
601
593
return False
602
594
606
598
def init_checker(self):
607
599
# Schedule a new checker to be started an 'interval' from now,
608
600
# and every interval from then on.
609
if self.checker_initiator_tag is not None:
610
gobject.source_remove(self.checker_initiator_tag)
611
601
self.checker_initiator_tag = (gobject.timeout_add
612
(int(self.interval
613
.total_seconds() * 1000),
602
(self.interval_milliseconds(),
614
603
self.start_checker))
615
604
# 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
605
self.disable_initiator_tag = (gobject.timeout_add
619
(int(self.timeout
620
.total_seconds() * 1000),
621
self.disable))
606
(self.timeout_milliseconds(),
607
self.disable))
622
608
# Also start a new checker *right now*.
623
609
self.start_checker()
624
610
640
626
logger.warning("Checker for %(name)s crashed?",
641
627
vars(self))
642
628
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."""
629
def checked_ok(self, timeout=None):
630
"""Bump up the timeout for this client.
631
632
This should only be called when the client has been seen,
633
alive and well.
634
"""
651
635
if timeout is None:
652
636
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
653
638
if self.disable_initiator_tag is not None:
654
639
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = None
656
640
if getattr(self, "enabled", False):
657
641
self.disable_initiator_tag = (gobject.timeout_add
658
(int(timeout.total_seconds()
659
* 1000), self.disable))
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
660
644
self.expires = datetime.datetime.utcnow() + timeout
661
645
662
646
def need_approval(self):
668
652
If a checker already exists, leave it running and do
669
653
nothing."""
670
654
# 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
655
# did that, then if a checker (for some reason) started
656
# running slowly and taking more than 'interval' time, the
657
# client would inevitably timeout, since no checker would get
658
# a chance to run to completion. If we instead leave running
675
659
# checkers alone, the checker would have to take more time
676
660
# than 'timeout' for the client to be disabled, which is as it
677
661
# should be.
679
663
# If a checker exists, make sure it is not a zombie
680
664
try:
681
665
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
666
except (AttributeError, OSError) as error:
667
if (isinstance(error, OSError)
668
and error.errno != errno.ECHILD):
669
raise error
687
670
else:
688
671
if pid:
689
672
logger.warning("Checker was a zombie")
692
675
self.current_checker_command)
693
676
# Start a new checker if needed
694
677
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
678
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
679
# In case checker_command has exactly one % operator
680
command = self.checker_command % self.host
681
except TypeError:
682
# Escape attributes for the shell
683
escaped_attrs = dict(
684
(attr,
685
re.escape(unicode(str(getattr(self, attr, "")),
686
errors=
687
'replace')))
688
for attr in
689
self.runtime_expansions)
690
691
try:
692
command = self.checker_command % escaped_attrs
693
except TypeError as error:
694
logger.error('Could not format string "%s":'
695
' %s', self.checker_command, error)
696
return True # Try again later
705
697
self.current_checker_command = command
706
698
try:
707
699
logger.info("Starting checker %r for %s",
710
702
# in normal mode, that is already done by daemon(),
711
703
# and in debug mode we don't want to. (Stdin is
712
704
# 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
705
self.checker = subprocess.Popen(command,
722
706
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:
707
shell=True, cwd="/")
708
self.checker_callback_tag = (gobject.child_watch_add
709
(self.checker.pid,
710
self.checker_callback,
711
data=command))
712
# The checker may have completed before the gobject
713
# watch was added. Check for this.
736
714
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
715
if pid:
716
gobject.source_remove(self.checker_callback_tag)
717
self.checker_callback(pid, status, command)
737
718
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)
719
logger.error("Failed to start subprocess: %s",
720
error)
747
721
# Re-run this periodically if run by gobject.timeout_add
748
722
return True
749
723
756
730
return
757
731
logger.debug("Stopping checker for %(name)s", vars(self))
758
732
try:
759
self.checker.terminate()
733
os.kill(self.checker.pid, signal.SIGTERM)
760
734
#time.sleep(0.5)
761
735
#if self.checker.poll() is None:
762
# self.checker.kill()
736
# os.kill(self.checker.pid, signal.SIGKILL)
763
737
except OSError as error:
764
738
if error.errno != errno.ESRCH: # No such process
765
739
raise
782
756
# "Set" method, so we fail early here:
783
757
if byte_arrays and signature != "ay":
784
758
raise ValueError("Byte arrays not supported for non-'ay'"
785
" signature {!r}".format(signature))
759
" signature %r" % signature)
786
760
def decorator(func):
787
761
func._dbus_is_property = True
788
762
func._dbus_interface = dbus_interface
796
770
return decorator
797
771
798
772
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
773
class DBusPropertyException(dbus.exceptions.DBusException):
837
774
"""A base class for D-Bus property-related exceptions
838
775
"""
839
pass
776
def __unicode__(self):
777
return unicode(str(self))
778
840
779
841
780
class DBusPropertyAccessException(DBusPropertyException):
842
781
"""A property's access permissions disallows an operation.
859
798
"""
860
799
861
800
@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)
801
def _is_dbus_property(obj):
802
return getattr(obj, "_dbus_is_property", False)
870
803
871
def _get_all_dbus_things(self, thing):
804
def _get_all_dbus_properties(self):
872
805
"""Returns a generator of (name, attribute) pairs
873
806
"""
874
return ((getattr(athing.__get__(self), "_dbus_name",
875
name),
876
athing.__get__(self))
807
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
877
808
for cls in self.__class__.__mro__
878
for name, athing in
879
inspect.getmembers(cls,
880
self._is_dbus_thing(thing)))
809
for name, prop in
810
inspect.getmembers(cls, self._is_dbus_property))
881
811
882
812
def _get_dbus_property(self, interface_name, property_name):
883
813
"""Returns a bound method if one exists which is a D-Bus
885
815
"""
886
816
for cls in self.__class__.__mro__:
887
817
for name, value in (inspect.getmembers
888
(cls,
889
self._is_dbus_thing("property"))):
818
(cls, self._is_dbus_property)):
890
819
if (value._dbus_name == property_name
891
820
and value._dbus_interface == interface_name):
892
821
return value.__get__(self)
920
849
# The byte_arrays option is not supported yet on
921
850
# signatures other than "ay".
922
851
if prop._dbus_signature != "ay":
923
raise ValueError("Byte arrays not supported for non-"
924
"'ay' signature {!r}"
925
.format(prop._dbus_signature))
852
raise ValueError
926
853
value = dbus.ByteArray(b''.join(chr(byte)
927
854
for byte in value))
928
855
prop(value)
936
863
Note: Will not include properties with access="write".
937
864
"""
938
865
properties = {}
939
for name, prop in self._get_all_dbus_things("property"):
866
for name, prop in self._get_all_dbus_properties():
940
867
if (interface_name
941
868
and interface_name != prop._dbus_interface):
942
869
# Interface non-empty but did not match
952
879
value.variant_level+1)
953
880
return dbus.Dictionary(properties, signature="sv")
954
881
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
882
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
964
883
out_signature="s",
965
884
path_keyword='object_path',
966
885
connection_keyword='connection')
967
886
def Introspect(self, object_path, connection):
968
"""Overloading of standard D-Bus method.
969
970
Inserts property tags and interface annotation tags.
887
"""Standard D-Bus method, overloaded to insert property tags.
971
888
"""
972
889
xmlstring = dbus.service.Object.Introspect(self, object_path,
973
890
connection)
980
897
e.setAttribute("access", prop._dbus_access)
981
898
return e
982
899
for if_tag in document.getElementsByTagName("interface"):
983
# Add property tags
984
900
for tag in (make_tag(document, name, prop)
985
901
for name, prop
986
in self._get_all_dbus_things("property")
902
in self._get_all_dbus_properties()
987
903
if prop._dbus_interface
988
904
== if_tag.getAttribute("name")):
989
905
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
906
# Add the names to the return values for the
1022
907
# "org.freedesktop.DBus.Properties" methods
1023
908
if (if_tag.getAttribute("name")
1038
923
except (AttributeError, xml.dom.DOMException,
1039
924
xml.parsers.expat.ExpatError) as error:
1040
925
logger.error("Failed to override Introspection method",
1041
exc_info=error)
926
error)
1042
927
return xmlstring
1043
928
1044
929
1045
def datetime_to_dbus(dt, variant_level=0):
930
def datetime_to_dbus (dt, variant_level=0):
1046
931
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1047
932
if dt is None:
1048
933
return dbus.String("", variant_level = variant_level)
1050
935
variant_level=variant_level)
1051
936
1052
937
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).
938
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
939
.__metaclass__):
940
"""Applied to an empty subclass of a D-Bus object, this metaclass
941
will add additional D-Bus attributes matching a certain pattern.
1075
942
"""
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):
943
def __new__(mcs, name, bases, attr):
944
# Go through all the base classes which could have D-Bus
945
# methods, signals, or properties in them
946
for base in (b for b in bases
947
if issubclass(b, dbus.service.Object)):
948
# Go though all attributes of the base class
949
for attrname, attribute in inspect.getmembers(base):
1083
950
# Ignore non-D-Bus attributes, and D-Bus attributes
1084
951
# with the wrong interface name
1085
952
if (not hasattr(attribute, "_dbus_interface")
1086
953
or not attribute._dbus_interface
1087
.startswith(orig_interface_name)):
954
.startswith("se.recompile.Mandos")):
1088
955
continue
1089
956
# Create an alternate D-Bus interface name based on
1090
957
# the current name
1091
958
alt_interface = (attribute._dbus_interface
1092
.replace(orig_interface_name,
1093
alt_interface_name))
1094
interface_names.add(alt_interface)
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1095
961
# Is this a D-Bus signal?
1096
962
if getattr(attribute, "_dbus_is_signal", False):
1097
# Extract the original non-method undecorated
1098
# function by black magic
963
# Extract the original non-method function by
964
# black magic
1099
965
nonmethod_func = (dict(
1100
966
zip(attribute.func_code.co_freevars,
1101
967
attribute.__closure__))["func"]
1112
978
nonmethod_func.func_name,
1113
979
nonmethod_func.func_defaults,
1114
980
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
981
# 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
982
# old and new functions, so both the old and new
983
# signals gets sent when the function is called
1125
984
def fixscope(func1, func2):
1126
985
"""This function is a scope container to pass
1127
986
func1 and func2 to the "call_both" function
1134
993
return call_both
1135
994
# Create the "call_both" function and add it to
1136
995
# the class
1137
attr[attrname] = fixscope(attribute, new_function)
996
attr[attrname] = fixscope(attribute,
997
new_function)
1138
998
# Is this a D-Bus method?
1139
999
elif getattr(attribute, "_dbus_is_method", False):
1140
1000
# Create a new, but exactly alike, function
1151
1011
attribute.func_name,
1152
1012
attribute.func_defaults,
1153
1013
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
1014
# Is this a D-Bus property?
1161
1015
elif getattr(attribute, "_dbus_is_property", False):
1162
1016
# Create a new, but exactly alike, function
1176
1030
attribute.func_name,
1177
1031
attribute.func_defaults,
1178
1032
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"})
1033
return type.__new__(mcs, name, bases, attr)
1034
1035
1224
1036
class ClientDBus(Client, DBusObjectWithProperties):
1225
1037
"""A Client class using D-Bus
1226
1038
1232
1044
runtime_expansions = (Client.runtime_expansions
1233
1045
+ ("dbus_object_path",))
1234
1046
1235
_interface = "se.recompile.Mandos.Client"
1236
1237
1047
# dbus.service.Object doesn't use super(), so we can't either.
1238
1048
1239
1049
def __init__(self, bus = None, *args, **kwargs):
1240
1050
self.bus = bus
1241
1051
Client.__init__(self, *args, **kwargs)
1052
self._approvals_pending = 0
1053
1054
self._approvals_pending = 0
1242
1055
# Only now, when this client is initialized, can it show up on
1243
1056
# the D-Bus
1244
client_object_name = str(self.name).translate(
1057
client_object_name = unicode(self.name).translate(
1245
1058
{ord("."): ord("_"),
1246
1059
ord("-"): ord("_")})
1247
1060
self.dbus_object_path = (dbus.ObjectPath
1248
1061
("/clients/" + client_object_name))
1249
1062
DBusObjectWithProperties.__init__(self, self.bus,
1250
1063
self.dbus_object_path)
1251
1064
1252
1065
def notifychangeproperty(transform_func,
1253
1066
dbus_name, type_func=lambda x: x,
1254
variant_level=1, invalidate_only=False,
1255
_interface=_interface):
1067
variant_level=1):
1256
1068
""" Modify a variable so that it's a property which announces
1257
1069
its changes to DBus.
1258
1070
1263
1075
to the D-Bus. Default: no transform
1264
1076
variant_level: D-Bus variant level. Default: 1
1265
1077
"""
1266
attrname = "_{}".format(dbus_name)
1078
attrname = "_{0}".format(dbus_name)
1267
1079
def setter(self, value):
1268
1080
if hasattr(self, "dbus_object_path"):
1269
1081
if (not hasattr(self, attrname) or
1270
1082
type_func(getattr(self, attrname, None))
1271
1083
!= 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())
1084
dbus_value = transform_func(type_func(value),
1085
variant_level
1086
=variant_level)
1087
self.PropertyChanged(dbus.String(dbus_name),
1088
dbus_value)
1287
1089
setattr(self, attrname, value)
1288
1090
1289
1091
return property(lambda self: getattr(self, attrname), setter)
1290
1092
1093
1291
1094
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1292
1095
approvals_pending = notifychangeproperty(dbus.Boolean,
1293
1096
"ApprovalPending",
1300
1103
checker is not None)
1301
1104
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1302
1105
"LastCheckedOK")
1303
last_checker_status = notifychangeproperty(dbus.Int16,
1304
"LastCheckerStatus")
1305
1106
last_approval_request = notifychangeproperty(
1306
1107
datetime_to_dbus, "LastApprovalRequest")
1307
1108
approved_by_default = notifychangeproperty(dbus.Boolean,
1309
1110
approval_delay = notifychangeproperty(dbus.UInt64,
1310
1111
"ApprovalDelay",
1311
1112
type_func =
1312
lambda td: td.total_seconds()
1313
* 1000)
1113
timedelta_to_milliseconds)
1314
1114
approval_duration = notifychangeproperty(
1315
1115
dbus.UInt64, "ApprovalDuration",
1316
type_func = lambda td: td.total_seconds() * 1000)
1116
type_func = timedelta_to_milliseconds)
1317
1117
host = notifychangeproperty(dbus.String, "Host")
1318
1118
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1319
type_func = lambda td:
1320
td.total_seconds() * 1000)
1119
type_func =
1120
timedelta_to_milliseconds)
1321
1121
extended_timeout = notifychangeproperty(
1322
1122
dbus.UInt64, "ExtendedTimeout",
1323
type_func = lambda td: td.total_seconds() * 1000)
1123
type_func = timedelta_to_milliseconds)
1324
1124
interval = notifychangeproperty(dbus.UInt64,
1325
1125
"Interval",
1326
1126
type_func =
1327
lambda td: td.total_seconds()
1328
* 1000)
1127
timedelta_to_milliseconds)
1329
1128
checker_command = notifychangeproperty(dbus.String, "Checker")
1330
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1331
invalidate_only=True)
1332
1129
1333
1130
del notifychangeproperty
1334
1131
1361
1158
*args, **kwargs)
1362
1159
1363
1160
def start_checker(self, *args, **kwargs):
1364
old_checker_pid = getattr(self.checker, "pid", None)
1161
old_checker = self.checker
1162
if self.checker is not None:
1163
old_checker_pid = self.checker.pid
1164
else:
1165
old_checker_pid = None
1365
1166
r = Client.start_checker(self, *args, **kwargs)
1366
1167
# Only if new checker process was started
1367
1168
if (self.checker is not None
1375
1176
return False
1376
1177
1377
1178
def approve(self, value=True):
1179
self.send_changedstate()
1378
1180
self.approved = value
1379
gobject.timeout_add(int(self.approval_duration.total_seconds()
1380
* 1000), self._reset_approved)
1381
self.send_changedstate()
1181
gobject.timeout_add(timedelta_to_milliseconds
1182
(self.approval_duration),
1183
self._reset_approved)
1184
1382
1185
1383
1186
## D-Bus methods, signals & properties
1384
1385
## Interfaces
1187
_interface = "se.recompile.Mandos.Client"
1386
1188
1387
1189
## Signals
1388
1190
1399
1201
pass
1400
1202
1401
1203
# PropertyChanged - signal
1402
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1403
1204
@dbus.service.signal(_interface, signature="sv")
1404
1205
def PropertyChanged(self, property, value):
1405
1206
"D-Bus signal"
1426
1227
"D-Bus signal"
1427
1228
return self.need_approval()
1428
1229
1230
# NeRwequest - signal
1231
@dbus.service.signal(_interface, signature="s")
1232
def NewRequest(self, ip):
1233
"""D-Bus signal
1234
Is sent after a client request a password.
1235
"""
1236
pass
1237
1429
1238
## Methods
1430
1239
1431
1240
# Approve - method
1481
1290
access="readwrite")
1482
1291
def ApprovalDelay_dbus_property(self, value=None):
1483
1292
if value is None: # get
1484
return dbus.UInt64(self.approval_delay.total_seconds()
1485
* 1000)
1293
return dbus.UInt64(self.approval_delay_milliseconds())
1486
1294
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1487
1295
1488
1296
# ApprovalDuration - property
1490
1298
access="readwrite")
1491
1299
def ApprovalDuration_dbus_property(self, value=None):
1492
1300
if value is None: # get
1493
return dbus.UInt64(self.approval_duration.total_seconds()
1494
* 1000)
1301
return dbus.UInt64(timedelta_to_milliseconds(
1302
self.approval_duration))
1495
1303
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1496
1304
1497
1305
# Name - property
1510
1318
def Host_dbus_property(self, value=None):
1511
1319
if value is None: # get
1512
1320
return dbus.String(self.host)
1513
self.host = str(value)
1321
self.host = unicode(value)
1514
1322
1515
1323
# Created - property
1516
1324
@dbus_service_property(_interface, signature="s", access="read")
1542
1350
return
1543
1351
return datetime_to_dbus(self.last_checked_ok)
1544
1352
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
1353
# Expires - property
1552
1354
@dbus_service_property(_interface, signature="s", access="read")
1553
1355
def Expires_dbus_property(self):
1563
1365
access="readwrite")
1564
1366
def Timeout_dbus_property(self, value=None):
1565
1367
if value is None: # get
1566
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
old_timeout = self.timeout
1368
return dbus.UInt64(self.timeout_milliseconds())
1568
1369
self.timeout = datetime.timedelta(0, 0, 0, value)
1569
# Reschedule disabling
1370
# Reschedule timeout
1570
1371
if self.enabled:
1571
1372
now = datetime.datetime.utcnow()
1572
self.expires += self.timeout - old_timeout
1573
if self.expires <= now:
1373
time_to_die = timedelta_to_milliseconds(
1374
(self.last_checked_ok + self.timeout) - now)
1375
if time_to_die <= 0:
1574
1376
# The timeout has passed
1575
1377
self.disable()
1576
1378
else:
1379
self.expires = (now +
1380
datetime.timedelta(milliseconds =
1381
time_to_die))
1577
1382
if (getattr(self, "disable_initiator_tag", None)
1578
1383
is None):
1579
1384
return
1580
1385
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))
1386
self.disable_initiator_tag = (gobject.timeout_add
1387
(time_to_die,
1388
self.disable))
1585
1389
1586
1390
# ExtendedTimeout - property
1587
1391
@dbus_service_property(_interface, signature="t",
1588
1392
access="readwrite")
1589
1393
def ExtendedTimeout_dbus_property(self, value=None):
1590
1394
if value is None: # get
1591
return dbus.UInt64(self.extended_timeout.total_seconds()
1592
* 1000)
1395
return dbus.UInt64(self.extended_timeout_milliseconds())
1593
1396
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1594
1397
1595
1398
# Interval - property
1597
1400
access="readwrite")
1598
1401
def Interval_dbus_property(self, value=None):
1599
1402
if value is None: # get
1600
return dbus.UInt64(self.interval.total_seconds() * 1000)
1403
return dbus.UInt64(self.interval_milliseconds())
1601
1404
self.interval = datetime.timedelta(0, 0, 0, value)
1602
1405
if getattr(self, "checker_initiator_tag", None) is None:
1603
1406
return
1614
1417
def Checker_dbus_property(self, value=None):
1615
1418
if value is None: # get
1616
1419
return dbus.String(self.checker_command)
1617
self.checker_command = str(value)
1420
self.checker_command = unicode(value)
1618
1421
1619
1422
# CheckerRunning - property
1620
1423
@dbus_service_property(_interface, signature="b",
1636
1439
@dbus_service_property(_interface, signature="ay",
1637
1440
access="write", byte_arrays=True)
1638
1441
def Secret_dbus_property(self, value):
1639
self.secret = bytes(value)
1442
self.secret = str(value)
1640
1443
1641
1444
del _interface
1642
1445
1667
1470
self._pipe.send(('setattr', name, value))
1668
1471
1669
1472
1473
class ClientDBusTransitional(ClientDBus):
1474
__metaclass__ = AlternateDBusNamesMetaclass
1475
1476
1670
1477
class ClientHandler(socketserver.BaseRequestHandler, object):
1671
1478
"""A class to handle client connections.
1672
1479
1676
1483
def handle(self):
1677
1484
with contextlib.closing(self.server.child_pipe) as child_pipe:
1678
1485
logger.info("TCP connection from: %s",
1679
str(self.client_address))
1486
unicode(self.client_address))
1680
1487
logger.debug("Pipe FD: %d",
1681
1488
self.server.child_pipe.fileno())
1682
1489
1708
1515
logger.debug("Protocol version: %r", line)
1709
1516
try:
1710
1517
if int(line.strip().split()[0]) > 1:
1711
raise RuntimeError(line)
1518
raise RuntimeError
1712
1519
except (ValueError, IndexError, RuntimeError) as error:
1713
1520
logger.error("Unknown protocol version: %s", error)
1714
1521
return
1740
1547
except KeyError:
1741
1548
return
1742
1549
1550
if self.server.use_dbus:
1551
# Emit D-Bus signal
1552
client.NewRequest(str(self.client_address))
1553
1743
1554
if client.approval_delay:
1744
1555
delay = client.approval_delay
1745
1556
client.approvals_pending += 1
1763
1574
if self.server.use_dbus:
1764
1575
# Emit D-Bus signal
1765
1576
client.NeedApproval(
1766
client.approval_delay.total_seconds()
1767
* 1000, client.approved_by_default)
1577
client.approval_delay_milliseconds(),
1578
client.approved_by_default)
1768
1579
else:
1769
1580
logger.warning("Client %s was not approved",
1770
1581
client.name)
1776
1587
#wait until timeout or approved
1777
1588
time = datetime.datetime.now()
1778
1589
client.changedstate.acquire()
1779
client.changedstate.wait(delay.total_seconds())
1590
(client.changedstate.wait
1591
(float(client.timedelta_to_milliseconds(delay)
1592
/ 1000)))
1780
1593
client.changedstate.release()
1781
1594
time2 = datetime.datetime.now()
1782
1595
if (time2 - time) >= delay:
1798
1611
try:
1799
1612
sent = session.send(client.secret[sent_size:])
1800
1613
except gnutls.errors.GNUTLSError as error:
1801
logger.warning("gnutls send failed",
1802
exc_info=error)
1614
logger.warning("gnutls send failed")
1803
1615
return
1804
1616
logger.debug("Sent: %d, remaining: %d",
1805
1617
sent, len(client.secret)
1808
1620
1809
1621
logger.info("Sending secret to %s", client.name)
1810
1622
# bump the timeout using extended_timeout
1811
client.bump_timeout(client.extended_timeout)
1623
client.checked_ok(client.extended_timeout)
1812
1624
if self.server.use_dbus:
1813
1625
# Emit D-Bus signal
1814
1626
client.GotSecret()
1819
1631
try:
1820
1632
session.bye()
1821
1633
except gnutls.errors.GNUTLSError as error:
1822
logger.warning("GnuTLS bye failed",
1823
exc_info=error)
1634
logger.warning("GnuTLS bye failed")
1824
1635
1825
1636
@staticmethod
1826
1637
def peer_certificate(session):
1898
1709
def process_request(self, request, address):
1899
1710
"""Start a new process to process the request."""
1900
1711
proc = multiprocessing.Process(target = self.sub_process_main,
1901
args = (request, address))
1712
args = (request,
1713
address))
1902
1714
proc.start()
1903
1715
return proc
1904
1716
1919
1731
1920
1732
def add_pipe(self, parent_pipe, proc):
1921
1733
"""Dummy function; override as necessary"""
1922
raise NotImplementedError()
1734
raise NotImplementedError
1923
1735
1924
1736
1925
1737
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1932
1744
use_ipv6: Boolean; to use IPv6 or not
1933
1745
"""
1934
1746
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
"""
1747
interface=None, use_ipv6=True):
1939
1748
self.interface = interface
1940
1749
if use_ipv6:
1941
1750
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
1751
socketserver.TCPServer.__init__(self, server_address,
1969
1752
RequestHandlerClass)
1970
1971
1753
def server_bind(self):
1972
1754
"""This overrides the normal server_bind() function
1973
1755
to bind to an interface if one was specified, and also NOT to
1981
1763
try:
1982
1764
self.socket.setsockopt(socket.SOL_SOCKET,
1983
1765
SO_BINDTODEVICE,
1984
(self.interface + "\0")
1985
.encode("utf-8"))
1766
str(self.interface
1767
+ '\0'))
1986
1768
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:
1769
if error[0] == errno.EPERM:
1770
logger.error("No permission to"
1771
" bind to interface %s",
1772
self.interface)
1773
elif error[0] == errno.ENOPROTOOPT:
1991
1774
logger.error("SO_BINDTODEVICE not available;"
1992
1775
" cannot bind to interface %s",
1993
1776
self.interface)
1994
elif error.errno == errno.ENODEV:
1995
logger.error("Interface %s does not exist,"
1996
" cannot bind", self.interface)
1997
1777
else:
1998
1778
raise
1999
1779
# Only bind(2) the socket if we really need to.
2002
1782
if self.address_family == socket.AF_INET6:
2003
1783
any_address = "::" # in6addr_any
2004
1784
else:
2005
any_address = "0.0.0.0" # INADDR_ANY
1785
any_address = socket.INADDR_ANY
2006
1786
self.server_address = (any_address,
2007
1787
self.server_address[1])
2008
1788
elif not self.server_address[1]:
2029
1809
"""
2030
1810
def __init__(self, server_address, RequestHandlerClass,
2031
1811
interface=None, use_ipv6=True, clients=None,
2032
gnutls_priority=None, use_dbus=True, socketfd=None):
1812
gnutls_priority=None, use_dbus=True):
2033
1813
self.enabled = False
2034
1814
self.clients = clients
2035
1815
if self.clients is None:
2039
1819
IPv6_TCPServer.__init__(self, server_address,
2040
1820
RequestHandlerClass,
2041
1821
interface = interface,
2042
use_ipv6 = use_ipv6,
2043
socketfd = socketfd)
1822
use_ipv6 = use_ipv6)
2044
1823
def server_activate(self):
2045
1824
if self.enabled:
2046
1825
return socketserver.TCPServer.server_activate(self)
2059
1838
2060
1839
def handle_ipc(self, source, condition, parent_pipe=None,
2061
1840
proc = None, client_object=None):
1841
condition_names = {
1842
gobject.IO_IN: "IN", # There is data to read.
1843
gobject.IO_OUT: "OUT", # Data can be written (without
1844
# blocking).
1845
gobject.IO_PRI: "PRI", # There is urgent data to read.
1846
gobject.IO_ERR: "ERR", # Error condition.
1847
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1848
# broken, usually for pipes and
1849
# sockets).
1850
}
1851
conditions_string = ' | '.join(name
1852
for cond, name in
1853
condition_names.iteritems()
1854
if cond & condition)
2062
1855
# error, or the other end of multiprocessing.Pipe has closed
2063
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1856
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2064
1857
# Wait for other process to exit
2065
1858
proc.join()
2066
1859
return False
2124
1917
return True
2125
1918
2126
1919
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
1920
def string_to_delta(interval):
2227
1921
"""Parse a string and return a datetime.timedelta
2228
1922
2239
1933
>>> string_to_delta('5m 30s')
2240
1934
datetime.timedelta(0, 330)
2241
1935
"""
2242
2243
try:
2244
return rfc3339_duration_to_delta(interval)
2245
except ValueError:
2246
pass
2247
2248
1936
timevalue = datetime.timedelta(0)
2249
1937
for s in interval.split():
2250
1938
try:
2251
suffix = s[-1]
1939
suffix = unicode(s[-1])
2252
1940
value = int(s[:-1])
2253
1941
if suffix == "d":
2254
1942
delta = datetime.timedelta(value)
2261
1949
elif suffix == "w":
2262
1950
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2263
1951
else:
2264
raise ValueError("Unknown suffix {!r}"
2265
.format(suffix))
2266
except IndexError as e:
1952
raise ValueError("Unknown suffix %r" % suffix)
1953
except (ValueError, IndexError) as e:
2267
1954
raise ValueError(*(e.args))
2268
1955
timevalue += delta
2269
1956
return timevalue
2282
1969
sys.exit()
2283
1970
if not noclose:
2284
1971
# Close all standard open file descriptors
2285
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1972
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2286
1973
if not stat.S_ISCHR(os.fstat(null).st_mode):
2287
raise OSError(errno.ENODEV, "{} not a character device"
2288
.format(os.devnull))
1974
raise OSError(errno.ENODEV,
1975
"%s not a character device"
1976
% os.path.devnull)
2289
1977
os.dup2(null, sys.stdin.fileno())
2290
1978
os.dup2(null, sys.stdout.fileno())
2291
1979
os.dup2(null, sys.stderr.fileno())
2300
1988
2301
1989
parser = argparse.ArgumentParser()
2302
1990
parser.add_argument("-v", "--version", action="version",
2303
version = "%(prog)s {}".format(version),
1991
version = "%%(prog)s %s" % version,
2304
1992
help="show version number and exit")
2305
1993
parser.add_argument("-i", "--interface", metavar="IF",
2306
1994
help="Bind to interface IF")
2312
2000
help="Run self-test")
2313
2001
parser.add_argument("--debug", action="store_true",
2314
2002
help="Debug mode; run in foreground and log"
2315
" to terminal", default=None)
2003
" to terminal")
2316
2004
parser.add_argument("--debuglevel", metavar="LEVEL",
2317
2005
help="Debug level for stdout output")
2318
2006
parser.add_argument("--priority", help="GnuTLS"
2325
2013
" files")
2326
2014
parser.add_argument("--no-dbus", action="store_false",
2327
2015
dest="use_dbus", help="Do not provide D-Bus"
2328
" system bus interface", default=None)
2016
" system bus interface")
2329
2017
parser.add_argument("--no-ipv6", action="store_false",
2330
dest="use_ipv6", help="Do not use IPv6",
2331
default=None)
2018
dest="use_ipv6", help="Do not use IPv6")
2332
2019
parser.add_argument("--no-restore", action="store_false",
2333
2020
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")
2021
" state")
2338
2022
parser.add_argument("--statedir", metavar="DIR",
2339
2023
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
2024
2346
2025
options = parser.parse_args()
2347
2026
2348
2027
if options.check:
2349
2028
import doctest
2350
fail_count, test_count = doctest.testmod()
2351
sys.exit(os.EX_OK if fail_count == 0 else 1)
2029
doctest.testmod()
2030
sys.exit()
2352
2031
2353
2032
# Default values for config file for server-global settings
2354
2033
server_defaults = { "interface": "",
2356
2035
"port": "",
2357
2036
"debug": "False",
2358
2037
"priority":
2359
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2038
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2360
2039
"servicename": "Mandos",
2361
2040
"use_dbus": "True",
2362
2041
"use_ipv6": "True",
2363
2042
"debuglevel": "",
2364
2043
"restore": "True",
2365
"socket": "",
2366
"statedir": "/var/lib/mandos",
2367
"foreground": "False",
2368
"zeroconf": "True",
2044
"statedir": "/var/lib/mandos"
2369
2045
}
2370
2046
2371
2047
# Parse config file for server-global settings
2376
2052
# Convert the SafeConfigParser object to a dict
2377
2053
server_settings = server_config.defaults()
2378
2054
# Use the appropriate methods on the non-string config options
2379
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2055
for option in ("debug", "use_dbus", "use_ipv6"):
2380
2056
server_settings[option] = server_config.getboolean("DEFAULT",
2381
2057
option)
2382
2058
if server_settings["port"]:
2383
2059
server_settings["port"] = server_config.getint("DEFAULT",
2384
2060
"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
2061
del server_config
2395
2062
2396
2063
# Override the settings from the config file with command line
2398
2065
for option in ("interface", "address", "port", "debug",
2399
2066
"priority", "servicename", "configdir",
2400
2067
"use_dbus", "use_ipv6", "debuglevel", "restore",
2401
"statedir", "socket", "foreground", "zeroconf"):
2068
"statedir"):
2402
2069
value = getattr(options, option)
2403
2070
if value is not None:
2404
2071
server_settings[option] = value
2405
2072
del options
2406
2073
# Force all strings to be unicode
2407
2074
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
2075
if type(server_settings[option]) is str:
2076
server_settings[option] = unicode(server_settings[option])
2418
2077
# Now we have our good server settings in "server_settings"
2419
2078
2420
2079
##################################################################
2421
2080
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
2081
# For convenience
2429
2082
debug = server_settings["debug"]
2430
2083
debuglevel = server_settings["debuglevel"]
2432
2085
use_ipv6 = server_settings["use_ipv6"]
2433
2086
stored_state_path = os.path.join(server_settings["statedir"],
2434
2087
stored_state_file)
2435
foreground = server_settings["foreground"]
2436
zeroconf = server_settings["zeroconf"]
2437
2088
2438
2089
if debug:
2439
2090
initlogger(debug, logging.DEBUG)
2446
2097
2447
2098
if server_settings["servicename"] != "Mandos":
2448
2099
syslogger.setFormatter(logging.Formatter
2449
('Mandos ({}) [%(process)d]:'
2450
' %(levelname)s: %(message)s'
2451
.format(server_settings
2452
["servicename"])))
2100
('Mandos (%s) [%%(process)d]:'
2101
' %%(levelname)s: %%(message)s'
2102
% server_settings["servicename"]))
2453
2103
2454
2104
# Parse config file with clients
2455
2105
client_config = configparser.SafeConfigParser(Client
2460
2110
global mandos_dbus_service
2461
2111
mandos_dbus_service = None
2462
2112
2463
socketfd = None
2464
if server_settings["socket"] != "":
2465
socketfd = server_settings["socket"]
2466
2113
tcp_server = MandosServer((server_settings["address"],
2467
2114
server_settings["port"]),
2468
2115
ClientHandler,
2471
2118
use_ipv6=use_ipv6,
2472
2119
gnutls_priority=
2473
2120
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
2121
use_dbus=use_dbus)
2122
if not debug:
2123
pidfilename = "/var/run/mandos.pid"
2481
2124
try:
2482
2125
pidfile = open(pidfilename, "w")
2483
except IOError as e:
2484
logger.error("Could not open file %r", pidfilename,
2485
exc_info=e)
2126
except IOError:
2127
logger.error("Could not open file %r", pidfilename)
2486
2128
2487
for name in ("_mandos", "mandos", "nobody"):
2129
try:
2130
uid = pwd.getpwnam("_mandos").pw_uid
2131
gid = pwd.getpwnam("_mandos").pw_gid
2132
except KeyError:
2488
2133
try:
2489
uid = pwd.getpwnam(name).pw_uid
2490
gid = pwd.getpwnam(name).pw_gid
2491
break
2134
uid = pwd.getpwnam("mandos").pw_uid
2135
gid = pwd.getpwnam("mandos").pw_gid
2492
2136
except KeyError:
2493
continue
2494
else:
2495
uid = 65534
2496
gid = 65534
2137
try:
2138
uid = pwd.getpwnam("nobody").pw_uid
2139
gid = pwd.getpwnam("nobody").pw_gid
2140
except KeyError:
2141
uid = 65534
2142
gid = 65534
2497
2143
try:
2498
2144
os.setgid(gid)
2499
2145
os.setuid(uid)
2500
2146
except OSError as error:
2501
if error.errno != errno.EPERM:
2502
raise
2147
if error[0] != errno.EPERM:
2148
raise error
2503
2149
2504
2150
if debug:
2505
2151
# Enable all possible GnuTLS debugging
2516
2162
.gnutls_global_set_log_function(debug_gnutls))
2517
2163
2518
2164
# Redirect stdin so all checkers get /dev/null
2519
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2165
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2520
2166
os.dup2(null, sys.stdin.fileno())
2521
2167
if null > 2:
2522
2168
os.close(null)
2523
2169
2524
2170
# Need to fork before connecting to D-Bus
2525
if not foreground:
2171
if not debug:
2526
2172
# Close all input and output, do double fork, etc.
2527
2173
daemon()
2528
2174
2529
# multiprocessing will use threads, so before we use gobject we
2530
# need to inform gobject that threads will be used.
2531
2175
gobject.threads_init()
2532
2176
2533
2177
global main_loop
2534
2178
# From the Avahi example code
2535
DBusGMainLoop(set_as_default=True)
2179
DBusGMainLoop(set_as_default=True )
2536
2180
main_loop = gobject.MainLoop()
2537
2181
bus = dbus.SystemBus()
2538
2182
# End of Avahi example code
2544
2188
("se.bsnet.fukt.Mandos", bus,
2545
2189
do_not_queue=True))
2546
2190
except dbus.exceptions.NameExistsException as e:
2547
logger.error("Disabling D-Bus:", exc_info=e)
2191
logger.error(unicode(e) + ", disabling D-Bus")
2548
2192
use_dbus = False
2549
2193
server_settings["use_dbus"] = False
2550
2194
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")))
2195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2196
service = AvahiServiceToSyslog(name =
2197
server_settings["servicename"],
2198
servicetype = "_mandos._tcp",
2199
protocol = protocol, bus = bus)
2200
if server_settings["interface"]:
2201
service.interface = (if_nametoindex
2202
(str(server_settings["interface"])))
2561
2203
2562
2204
global multiprocessing_manager
2563
2205
multiprocessing_manager = multiprocessing.Manager()
2564
2206
2565
2207
client_class = Client
2566
2208
if use_dbus:
2567
client_class = functools.partial(ClientDBus, bus = bus)
2209
client_class = functools.partial(ClientDBusTransitional,
2210
bus = bus)
2568
2211
2569
2212
client_settings = Client.config_parser(client_config)
2570
2213
old_client_settings = {}
2571
2214
clients_data = {}
2572
2215
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()
2580
2581
2216
# Get client data and settings from last running state.
2582
2217
if server_settings["restore"]:
2583
2218
try:
2586
2221
(stored_state))
2587
2222
os.remove(stored_state_path)
2588
2223
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)
2224
logger.warning("Could not load persistent state: {0}"
2225
.format(e))
2226
if e.errno != errno.ENOENT:
2595
2227
raise
2596
2228
except EOFError as e:
2597
2229
logger.warning("Could not load persistent state: "
2598
"EOFError:", exc_info=e)
2230
"EOFError: {0}".format(e))
2599
2231
2600
2232
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
2605
2233
for client_name, client in clients_data.iteritems():
2606
2234
# Decide which value to use after restoring saved state.
2607
2235
# We have three different values: Old config file,
2608
2236
# new config file, and saved state.
2622
2250
2623
2251
# Clients who has passed its expire date can still be
2624
2252
# 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.
2253
# whose checker failed before we stored its state is
2254
# assumed to have failed all checkers during downtime.
2628
2255
if client["enabled"]:
2629
2256
if datetime.datetime.utcnow() >= client["expires"]:
2630
2257
if not client["last_checked_ok"]:
2631
2258
logger.warning(
2632
"disabling client {} - Client never "
2633
"performed a successful checker"
2634
.format(client_name))
2259
"disabling client {0} - Client never "
2260
"performed a successfull checker"
2261
.format(client["name"]))
2635
2262
client["enabled"] = False
2636
2263
elif client["last_checker_status"] != 0:
2637
2264
logger.warning(
2638
"disabling client {} - Client last"
2639
" checker failed with error code {}"
2640
.format(client_name,
2265
"disabling client {0} - Client "
2266
"last checker failed with error code {1}"
2267
.format(client["name"],
2641
2268
client["last_checker_status"]))
2642
2269
client["enabled"] = False
2643
2270
else:
2645
2272
.utcnow()
2646
2273
+ client["timeout"])
2647
2274
logger.debug("Last checker succeeded,"
2648
" keeping {} enabled"
2649
.format(client_name))
2275
" keeping {0} enabled"
2276
.format(client["name"]))
2650
2277
try:
2651
2278
client["secret"] = (
2652
2279
pgp.decrypt(client["encrypted_secret"],
2654
2281
["secret"]))
2655
2282
except PGPError:
2656
2283
# If decryption fails, we use secret from new settings
2657
logger.debug("Failed to decrypt {} old secret"
2284
logger.debug("Failed to decrypt {0} old secret"
2658
2285
.format(client_name))
2659
2286
client["secret"] = (
2660
2287
client_settings[client_name]["secret"])
2288
2661
2289
2662
2290
# Add/remove clients based on new changes made to config
2663
2291
for client_name in (set(old_client_settings)
2666
2294
for client_name in (set(client_settings)
2667
2295
- set(old_client_settings)):
2668
2296
clients_data[client_name] = client_settings[client_name]
2669
2670
# Create all client objects
2671
for client_name, client in clients_data.items():
2297
2298
# Create clients all clients
2299
for client_name, client in clients_data.iteritems():
2672
2300
tcp_server.clients[client_name] = client_class(
2673
name = client_name, settings = client,
2674
server_settings = server_settings)
2301
name = client_name, settings = client)
2675
2302
2676
2303
if not tcp_server.clients:
2677
2304
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
2305
2306
if not debug:
2307
try:
2308
with pidfile:
2309
pid = os.getpid()
2310
pidfile.write(str(pid) + "\n".encode("utf-8"))
2311
del pidfile
2312
except IOError:
2313
logger.error("Could not write to file %r with PID %d",
2314
pidfilename, pid)
2315
except NameError:
2316
# "pidfile" was never created
2317
pass
2689
2318
del pidfilename
2319
signal.signal(signal.SIGINT, signal.SIG_IGN)
2690
2320
2691
2321
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2692
2322
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2693
2323
2694
2324
if use_dbus:
2695
@alternate_dbus_interfaces({"se.recompile.Mandos":
2696
"se.bsnet.fukt.Mandos"})
2697
class MandosDBusService(DBusObjectWithProperties):
2325
class MandosDBusService(dbus.service.Object):
2698
2326
"""A D-Bus proxy object"""
2699
2327
def __init__(self):
2700
2328
dbus.service.Object.__init__(self, bus, "/")
2701
2329
_interface = "se.recompile.Mandos"
2702
2330
2703
@dbus_interface_annotations(_interface)
2704
def _foo(self):
2705
return { "org.freedesktop.DBus.Property"
2706
".EmitsChangedSignal":
2707
"false"}
2708
2709
2331
@dbus.service.signal(_interface, signature="o")
2710
2332
def ClientAdded(self, objpath):
2711
2333
"D-Bus signal"
2733
2355
def GetAllClientsWithProperties(self):
2734
2356
"D-Bus method"
2735
2357
return dbus.Dictionary(
2736
{ c.dbus_object_path: c.GetAll("")
2737
for c in tcp_server.clients.itervalues() },
2358
((c.dbus_object_path, c.GetAll(""))
2359
for c in tcp_server.clients.itervalues()),
2738
2360
signature="oa{sv}")
2739
2361
2740
2362
@dbus.service.method(_interface, in_signature="o")
2753
2375
2754
2376
del _interface
2755
2377
2756
mandos_dbus_service = MandosDBusService()
2378
class MandosDBusServiceTransitional(MandosDBusService):
2379
__metaclass__ = AlternateDBusNamesMetaclass
2380
mandos_dbus_service = MandosDBusServiceTransitional()
2757
2381
2758
2382
def cleanup():
2759
2383
"Cleanup function; run on exit"
2760
if zeroconf:
2761
service.cleanup()
2384
service.cleanup()
2762
2385
2763
2386
multiprocessing.active_children()
2764
wnull.close()
2765
2387
if not (tcp_server.clients or client_settings):
2766
2388
return
2767
2389
2778
2400
2779
2401
# A list of attributes that can not be pickled
2780
2402
# + secret.
2781
exclude = { "bus", "changedstate", "secret",
2782
"checker", "server_settings" }
2403
exclude = set(("bus", "changedstate", "secret",
2404
"checker"))
2783
2405
for name, typ in (inspect.getmembers
2784
2406
(dbus.service.Object)):
2785
2407
exclude.add(name)
2794
2416
del client_settings[client.name]["secret"]
2795
2417
2796
2418
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:
2419
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2420
prefix="clients-",
2421
dir=os.path.dirname
2422
(stored_state_path))
2423
with os.fdopen(tempfd, "wb") as stored_state:
2801
2424
pickle.dump((clients, client_settings), stored_state)
2802
tempname=stored_state.name
2803
2425
os.rename(tempname, stored_state_path)
2804
2426
except (IOError, OSError) as e:
2427
logger.warning("Could not save persistent state: {0}"
2428
.format(e))
2805
2429
if not debug:
2806
2430
try:
2807
2431
os.remove(tempname)
2808
2432
except NameError:
2809
2433
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)
2816
raise
2434
if e.errno not in set((errno.ENOENT, errno.EACCES,
2435
errno.EEXIST)):
2436
raise e
2817
2437
2818
2438
# Delete all clients, and settings from config
2819
2439
while tcp_server.clients:
2843
2463
tcp_server.server_activate()
2844
2464
2845
2465
# Find out what port we got
2846
if zeroconf:
2847
service.port = tcp_server.socket.getsockname()[1]
2466
service.port = tcp_server.socket.getsockname()[1]
2848
2467
if use_ipv6:
2849
2468
logger.info("Now listening on address %r, port %d,"
2850
" flowinfo %d, scope_id %d",
2851
*tcp_server.socket.getsockname())
2469
" flowinfo %d, scope_id %d"
2470
% tcp_server.socket.getsockname())
2852
2471
else: # IPv4
2853
logger.info("Now listening on address %r, port %d",
2854
*tcp_server.socket.getsockname())
2472
logger.info("Now listening on address %r, port %d"
2473
% tcp_server.socket.getsockname())
2855
2474
2856
2475
#service.interface = tcp_server.socket.getsockname()[3]
2857
2476
2858
2477
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
2478
# From the Avahi example code
2479
try:
2480
service.activate()
2481
except dbus.exceptions.DBusException as error:
2482
logger.critical("DBusException: %s", error)
2483
cleanup()
2484
sys.exit(1)
2485
# End of Avahi example code
2868
2486
2869
2487
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2870
2488
lambda *args, **kwargs:
2874
2492
logger.debug("Starting main loop")
2875
2493
main_loop.run()
2876
2494
except AvahiError as error:
2877
logger.critical("Avahi Error", exc_info=error)
2495
logger.critical("AvahiError: %s", error)
2878
2496
cleanup()
2879
2497
sys.exit(1)
2880
2498
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0