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 789
- compare with another revision
- download diff
- download tarball
- view history from revision 789
- Committer: Teddy Hogeborn
- Date: 2015-10-04 13:44:03 UTC
- Revision ID: teddy@recompile.se-20151004134403-jn72bwgbw3aocllk
* initramfs-tools-hook: Don't try to chmod symlinks.
- files added:
- debian/mandos-client.examples
- debian/upstream
- plugin-helpers
- files modified:
- DBUS-API
added
removed
mandos
1
#!/usr/bin/python
1
#!/usr/bin/python2.7
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-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
14
# Copyright © 2008-2015 Teddy Hogeborn
15
# Copyright © 2008-2015 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
36
36
37
37
from future_builtins import *
38
38
39
import SocketServer as socketserver
39
try:
40
import SocketServer as socketserver
41
except ImportError:
42
import socketserver
40
43
import socket
41
44
import argparse
42
45
import datetime
47
50
import gnutls.library.functions
48
51
import gnutls.library.constants
49
52
import gnutls.library.types
50
import ConfigParser as configparser
53
try:
54
import ConfigParser as configparser
55
except ImportError:
56
import configparser
51
57
import sys
52
58
import re
53
59
import os
62
68
import struct
63
69
import fcntl
64
70
import functools
65
import cPickle as pickle
71
try:
72
import cPickle as pickle
73
except ImportError:
74
import pickle
66
75
import multiprocessing
67
76
import types
68
77
import binascii
69
78
import tempfile
70
79
import itertools
80
import collections
81
import codecs
71
82
72
83
import dbus
73
84
import dbus.service
74
import gobject
85
try:
86
import gobject
87
except ImportError:
88
from gi.repository import GObject as gobject
75
89
import avahi
76
90
from dbus.mainloop.glib import DBusGMainLoop
77
91
import ctypes
78
92
import ctypes.util
79
93
import xml.dom.minidom
80
94
import inspect
81
import GnuPGInterface
82
95
83
96
try:
84
97
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
101
except ImportError:
89
102
SO_BINDTODEVICE = None
90
103
91
version = "1.5.4"
104
if sys.version_info.major == 2:
105
str = unicode
106
107
version = "1.7.0"
92
108
stored_state_file = "clients.pickle"
93
109
94
110
logger = logging.getLogger()
95
syslogger = (logging.handlers.SysLogHandler
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
address = str("/dev/log")))
111
syslogger = None
98
112
99
113
try:
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
102
.if_nametoindex)
114
if_nametoindex = ctypes.cdll.LoadLibrary(
115
ctypes.util.find_library("c")).if_nametoindex
103
116
except (OSError, AttributeError):
117
104
118
def if_nametoindex(interface):
105
119
"Get an interface index the hard way, i.e. using fcntl()"
106
120
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
107
121
with contextlib.closing(socket.socket()) as s:
108
122
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
struct.pack(str("16s16x"),
110
interface))
111
interface_index = struct.unpack(str("I"),
112
ifreq[16:20])[0]
123
struct.pack(b"16s16x", interface))
124
interface_index = struct.unpack("I", ifreq[16:20])[0]
113
125
return interface_index
114
126
115
127
116
128
def initlogger(debug, level=logging.WARNING):
117
129
"""init logger and add loglevel"""
118
130
131
global syslogger
132
syslogger = (logging.handlers.SysLogHandler(
133
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
134
address = "/dev/log"))
119
135
syslogger.setFormatter(logging.Formatter
120
136
('Mandos [%(process)d]: %(levelname)s:'
121
137
' %(message)s'))
138
154
139
155
class PGPEngine(object):
140
156
"""A simple class for OpenPGP symmetric encryption & decryption"""
157
141
158
def __init__(self):
142
self.gnupg = GnuPGInterface.GnuPG()
143
159
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
144
self.gnupg = GnuPGInterface.GnuPG()
145
self.gnupg.options.meta_interactive = False
146
self.gnupg.options.homedir = self.tempdir
147
self.gnupg.options.extra_args.extend(['--force-mdc',
148
'--quiet',
149
'--no-use-agent'])
160
self.gnupgargs = ['--batch',
161
'--home', self.tempdir,
162
'--force-mdc',
163
'--quiet',
164
'--no-use-agent']
150
165
151
166
def __enter__(self):
152
167
return self
174
189
def password_encode(self, password):
175
190
# Passphrase can not be empty and can not contain newlines or
176
191
# NUL bytes. So we prefix it and hex encode it.
177
return b"mandos" + binascii.hexlify(password)
192
encoded = b"mandos" + binascii.hexlify(password)
193
if len(encoded) > 2048:
194
# GnuPG can't handle long passwords, so encode differently
195
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
196
.replace(b"\n", b"\\n")
197
.replace(b"\0", b"\\x00"))
198
return encoded
178
199
179
200
def encrypt(self, data, password):
180
self.gnupg.passphrase = self.password_encode(password)
181
with open(os.devnull, "w") as devnull:
182
try:
183
proc = self.gnupg.run(['--symmetric'],
184
create_fhs=['stdin', 'stdout'],
185
attach_fhs={'stderr': devnull})
186
with contextlib.closing(proc.handles['stdin']) as f:
187
f.write(data)
188
with contextlib.closing(proc.handles['stdout']) as f:
189
ciphertext = f.read()
190
proc.wait()
191
except IOError as e:
192
raise PGPError(e)
193
self.gnupg.passphrase = None
201
passphrase = self.password_encode(password)
202
with tempfile.NamedTemporaryFile(
203
dir=self.tempdir) as passfile:
204
passfile.write(passphrase)
205
passfile.flush()
206
proc = subprocess.Popen(['gpg', '--symmetric',
207
'--passphrase-file',
208
passfile.name]
209
+ self.gnupgargs,
210
stdin = subprocess.PIPE,
211
stdout = subprocess.PIPE,
212
stderr = subprocess.PIPE)
213
ciphertext, err = proc.communicate(input = data)
214
if proc.returncode != 0:
215
raise PGPError(err)
194
216
return ciphertext
195
217
196
218
def decrypt(self, data, password):
197
self.gnupg.passphrase = self.password_encode(password)
198
with open(os.devnull, "w") as devnull:
199
try:
200
proc = self.gnupg.run(['--decrypt'],
201
create_fhs=['stdin', 'stdout'],
202
attach_fhs={'stderr': devnull})
203
with contextlib.closing(proc.handles['stdin']) as f:
204
f.write(data)
205
with contextlib.closing(proc.handles['stdout']) as f:
206
decrypted_plaintext = f.read()
207
proc.wait()
208
except IOError as e:
209
raise PGPError(e)
210
self.gnupg.passphrase = None
219
passphrase = self.password_encode(password)
220
with tempfile.NamedTemporaryFile(
221
dir = self.tempdir) as passfile:
222
passfile.write(passphrase)
223
passfile.flush()
224
proc = subprocess.Popen(['gpg', '--decrypt',
225
'--passphrase-file',
226
passfile.name]
227
+ self.gnupgargs,
228
stdin = subprocess.PIPE,
229
stdout = subprocess.PIPE,
230
stderr = subprocess.PIPE)
231
decrypted_plaintext, err = proc.communicate(input = data)
232
if proc.returncode != 0:
233
raise PGPError(err)
211
234
return decrypted_plaintext
212
235
213
236
214
237
class AvahiError(Exception):
215
238
def __init__(self, value, *args, **kwargs):
216
239
self.value = value
217
super(AvahiError, self).__init__(value, *args, **kwargs)
218
def __unicode__(self):
219
return unicode(repr(self.value))
240
return super(AvahiError, self).__init__(value, *args,
241
**kwargs)
242
220
243
221
244
class AvahiServiceError(AvahiError):
222
245
pass
223
246
247
224
248
class AvahiGroupError(AvahiError):
225
249
pass
226
250
233
257
Used to optionally bind to the specified interface.
234
258
name: string; Example: 'Mandos'
235
259
type: string; Example: '_mandos._tcp'.
236
See <http://www.dns-sd.org/ServiceTypes.html>
260
See <https://www.iana.org/assignments/service-names-port-numbers>
237
261
port: integer; what port to announce
238
262
TXT: list of strings; TXT record for the service
239
263
domain: string; Domain to publish on, default to .local if empty.
246
270
bus: dbus.SystemBus()
247
271
"""
248
272
249
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
250
servicetype = None, port = None, TXT = None,
251
domain = "", host = "", max_renames = 32768,
252
protocol = avahi.PROTO_UNSPEC, bus = None):
273
def __init__(self,
274
interface = avahi.IF_UNSPEC,
275
name = None,
276
servicetype = None,
277
port = None,
278
TXT = None,
279
domain = "",
280
host = "",
281
max_renames = 32768,
282
protocol = avahi.PROTO_UNSPEC,
283
bus = None):
253
284
self.interface = interface
254
285
self.name = name
255
286
self.type = servicetype
265
296
self.bus = bus
266
297
self.entry_group_state_changed_match = None
267
298
268
def rename(self):
299
def rename(self, remove=True):
269
300
"""Derived from the Avahi example code"""
270
301
if self.rename_count >= self.max_renames:
271
302
logger.critical("No suitable Zeroconf service name found"
272
303
" after %i retries, exiting.",
273
304
self.rename_count)
274
305
raise AvahiServiceError("Too many renames")
275
self.name = unicode(self.server
276
.GetAlternativeServiceName(self.name))
306
self.name = str(
307
self.server.GetAlternativeServiceName(self.name))
308
self.rename_count += 1
277
309
logger.info("Changing Zeroconf service name to %r ...",
278
310
self.name)
279
self.remove()
311
if remove:
312
self.remove()
280
313
try:
281
314
self.add()
282
315
except dbus.exceptions.DBusException as error:
283
logger.critical("D-Bus Exception", exc_info=error)
284
self.cleanup()
285
os._exit(1)
286
self.rename_count += 1
316
if (error.get_dbus_name()
317
== "org.freedesktop.Avahi.CollisionError"):
318
logger.info("Local Zeroconf service name collision.")
319
return self.rename(remove=False)
320
else:
321
logger.critical("D-Bus Exception", exc_info=error)
322
self.cleanup()
323
os._exit(1)
287
324
288
325
def remove(self):
289
326
"""Derived from the Avahi example code"""
327
364
self.rename()
328
365
elif state == avahi.ENTRY_GROUP_FAILURE:
329
366
logger.critical("Avahi: Error in group state changed %s",
330
unicode(error))
331
raise AvahiGroupError("State changed: {0!s}"
332
.format(error))
367
str(error))
368
raise AvahiGroupError("State changed: {!s}".format(error))
333
369
334
370
def cleanup(self):
335
371
"""Derived from the Avahi example code"""
345
381
def server_state_changed(self, state, error=None):
346
382
"""Derived from the Avahi example code"""
347
383
logger.debug("Avahi server state change: %i", state)
348
bad_states = { avahi.SERVER_INVALID:
349
"Zeroconf server invalid",
350
avahi.SERVER_REGISTERING: None,
351
avahi.SERVER_COLLISION:
352
"Zeroconf server name collision",
353
avahi.SERVER_FAILURE:
354
"Zeroconf server failure" }
384
bad_states = {
385
avahi.SERVER_INVALID: "Zeroconf server invalid",
386
avahi.SERVER_REGISTERING: None,
387
avahi.SERVER_COLLISION: "Zeroconf server name collision",
388
avahi.SERVER_FAILURE: "Zeroconf server failure",
389
}
355
390
if state in bad_states:
356
391
if bad_states[state] is not None:
357
392
if error is None:
360
395
logger.error(bad_states[state] + ": %r", error)
361
396
self.cleanup()
362
397
elif state == avahi.SERVER_RUNNING:
363
self.add()
398
try:
399
self.add()
400
except dbus.exceptions.DBusException as error:
401
if (error.get_dbus_name()
402
== "org.freedesktop.Avahi.CollisionError"):
403
logger.info("Local Zeroconf service name"
404
" collision.")
405
return self.rename(remove=False)
406
else:
407
logger.critical("D-Bus Exception", exc_info=error)
408
self.cleanup()
409
os._exit(1)
364
410
else:
365
411
if error is None:
366
412
logger.debug("Unknown state: %r", state)
376
422
follow_name_owner_changes=True),
377
423
avahi.DBUS_INTERFACE_SERVER)
378
424
self.server.connect_to_signal("StateChanged",
379
self.server_state_changed)
425
self.server_state_changed)
380
426
self.server_state_changed(self.server.GetState())
381
427
382
428
383
429
class AvahiServiceToSyslog(AvahiService):
384
def rename(self):
430
def rename(self, *args, **kwargs):
385
431
"""Add the new name to the syslog messages"""
386
ret = AvahiService.rename(self)
387
syslogger.setFormatter(logging.Formatter
388
('Mandos ({0}) [%(process)d]:'
389
' %(levelname)s: %(message)s'
390
.format(self.name)))
432
ret = AvahiService.rename(self, *args, **kwargs)
433
syslogger.setFormatter(logging.Formatter(
434
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
435
.format(self.name)))
391
436
return ret
392
437
393
394
def timedelta_to_milliseconds(td):
395
"Convert a datetime.timedelta() to milliseconds"
396
return ((td.days * 24 * 60 * 60 * 1000)
397
+ (td.seconds * 1000)
398
+ (td.microseconds // 1000))
399
438
def call_pipe(connection, # : multiprocessing.Connection
439
func, *args, **kwargs):
440
"""This function is meant to be called by multiprocessing.Process
441
442
This function runs func(*args, **kwargs), and writes the resulting
443
return value on the provided multiprocessing.Connection.
444
"""
445
connection.send(func(*args, **kwargs))
446
connection.close()
400
447
401
448
class Client(object):
402
449
"""A representation of a client host served by this server.
429
476
last_checker_status: integer between 0 and 255 reflecting exit
430
477
status of last checker. -1 reflects crashed
431
478
checker, -2 means no checker completed yet.
479
last_checker_signal: The signal which killed the last checker, if
480
last_checker_status is -1
432
481
last_enabled: datetime.datetime(); (UTC) or None
433
482
name: string; from the config file, used in log messages and
434
483
D-Bus identifiers
439
488
runtime_expansions: Allowed attributes for runtime expansion.
440
489
expires: datetime.datetime(); time (UTC) when a client will be
441
490
disabled, or None
491
server_settings: The server_settings dict from main()
442
492
"""
443
493
444
494
runtime_expansions = ("approval_delay", "approval_duration",
446
496
"fingerprint", "host", "interval",
447
497
"last_approval_request", "last_checked_ok",
448
498
"last_enabled", "name", "timeout")
449
client_defaults = { "timeout": "5m",
450
"extended_timeout": "15m",
451
"interval": "2m",
452
"checker": "fping -q -- %%(host)s",
453
"host": "",
454
"approval_delay": "0s",
455
"approval_duration": "1s",
456
"approved_by_default": "True",
457
"enabled": "True",
458
}
459
460
def timeout_milliseconds(self):
461
"Return the 'timeout' attribute in milliseconds"
462
return timedelta_to_milliseconds(self.timeout)
463
464
def extended_timeout_milliseconds(self):
465
"Return the 'extended_timeout' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.extended_timeout)
467
468
def interval_milliseconds(self):
469
"Return the 'interval' attribute in milliseconds"
470
return timedelta_to_milliseconds(self.interval)
471
472
def approval_delay_milliseconds(self):
473
return timedelta_to_milliseconds(self.approval_delay)
499
client_defaults = {
500
"timeout": "PT5M",
501
"extended_timeout": "PT15M",
502
"interval": "PT2M",
503
"checker": "fping -q -- %%(host)s",
504
"host": "",
505
"approval_delay": "PT0S",
506
"approval_duration": "PT1S",
507
"approved_by_default": "True",
508
"enabled": "True",
509
}
474
510
475
511
@staticmethod
476
512
def config_parser(config):
492
528
client["enabled"] = config.getboolean(client_name,
493
529
"enabled")
494
530
531
# Uppercase and remove spaces from fingerprint for later
532
# comparison purposes with return value from the
533
# fingerprint() function
495
534
client["fingerprint"] = (section["fingerprint"].upper()
496
535
.replace(" ", ""))
497
536
if "secret" in section:
502
541
"rb") as secfile:
503
542
client["secret"] = secfile.read()
504
543
else:
505
raise TypeError("No secret or secfile for section {0}"
544
raise TypeError("No secret or secfile for section {}"
506
545
.format(section))
507
546
client["timeout"] = string_to_delta(section["timeout"])
508
547
client["extended_timeout"] = string_to_delta(
519
558
520
559
return settings
521
560
522
def __init__(self, settings, name = None):
561
def __init__(self, settings, name = None, server_settings=None):
523
562
self.name = name
563
if server_settings is None:
564
server_settings = {}
565
self.server_settings = server_settings
524
566
# adding all client settings
525
for setting, value in settings.iteritems():
567
for setting, value in settings.items():
526
568
setattr(self, setting, value)
527
569
528
570
if self.enabled:
536
578
self.expires = None
537
579
538
580
logger.debug("Creating client %r", self.name)
539
# Uppercase and remove spaces from fingerprint for later
540
# comparison purposes with return value from the fingerprint()
541
# function
542
581
logger.debug(" Fingerprint: %s", self.fingerprint)
543
582
self.created = settings.get("created",
544
583
datetime.datetime.utcnow())
551
590
self.current_checker_command = None
552
591
self.approved = None
553
592
self.approvals_pending = 0
554
self.changedstate = (multiprocessing_manager
555
.Condition(multiprocessing_manager
556
.Lock()))
557
self.client_structure = [attr for attr in
558
self.__dict__.iterkeys()
593
self.changedstate = multiprocessing_manager.Condition(
594
multiprocessing_manager.Lock())
595
self.client_structure = [attr
596
for attr in self.__dict__.iterkeys()
559
597
if not attr.startswith("_")]
560
598
self.client_structure.append("client_structure")
561
599
562
for name, t in inspect.getmembers(type(self),
563
lambda obj:
564
isinstance(obj,
565
property)):
600
for name, t in inspect.getmembers(
601
type(self), lambda obj: isinstance(obj, property)):
566
602
if not name.startswith("_"):
567
603
self.client_structure.append(name)
568
604
610
646
# and every interval from then on.
611
647
if self.checker_initiator_tag is not None:
612
648
gobject.source_remove(self.checker_initiator_tag)
613
self.checker_initiator_tag = (gobject.timeout_add
614
(self.interval_milliseconds(),
615
self.start_checker))
649
self.checker_initiator_tag = gobject.timeout_add(
650
int(self.interval.total_seconds() * 1000),
651
self.start_checker)
616
652
# Schedule a disable() when 'timeout' has passed
617
653
if self.disable_initiator_tag is not None:
618
654
gobject.source_remove(self.disable_initiator_tag)
619
self.disable_initiator_tag = (gobject.timeout_add
620
(self.timeout_milliseconds(),
621
self.disable))
655
self.disable_initiator_tag = gobject.timeout_add(
656
int(self.timeout.total_seconds() * 1000), self.disable)
622
657
# Also start a new checker *right now*.
623
658
self.start_checker()
624
659
625
def checker_callback(self, pid, condition, command):
660
def checker_callback(self, source, condition, connection,
661
command):
626
662
"""The checker has completed, so take appropriate actions."""
627
663
self.checker_callback_tag = None
628
664
self.checker = None
629
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
665
# Read return code from connection (see call_pipe)
666
returncode = connection.recv()
667
connection.close()
668
669
if returncode >= 0:
670
self.last_checker_status = returncode
671
self.last_checker_signal = None
631
672
if self.last_checker_status == 0:
632
673
logger.info("Checker for %(name)s succeeded",
633
674
vars(self))
634
675
self.checked_ok()
635
676
else:
636
logger.info("Checker for %(name)s failed",
637
vars(self))
677
logger.info("Checker for %(name)s failed", vars(self))
638
678
else:
639
679
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
640
681
logger.warning("Checker for %(name)s crashed?",
641
682
vars(self))
683
return False
642
684
643
685
def checked_ok(self):
644
686
"""Assert that the client has been seen, alive and well."""
645
687
self.last_checked_ok = datetime.datetime.utcnow()
646
688
self.last_checker_status = 0
689
self.last_checker_signal = None
647
690
self.bump_timeout()
648
691
649
692
def bump_timeout(self, timeout=None):
654
697
gobject.source_remove(self.disable_initiator_tag)
655
698
self.disable_initiator_tag = None
656
699
if getattr(self, "enabled", False):
657
self.disable_initiator_tag = (gobject.timeout_add
658
(timedelta_to_milliseconds
659
(timeout), self.disable))
700
self.disable_initiator_tag = gobject.timeout_add(
701
int(timeout.total_seconds() * 1000), self.disable)
660
702
self.expires = datetime.datetime.utcnow() + timeout
661
703
662
704
def need_approval(self):
676
718
# than 'timeout' for the client to be disabled, which is as it
677
719
# should be.
678
720
679
# If a checker exists, make sure it is not a zombie
680
try:
681
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
except (AttributeError, OSError) as error:
683
if (isinstance(error, OSError)
684
and error.errno != errno.ECHILD):
685
raise error
686
else:
687
if pid:
688
logger.warning("Checker was a zombie")
689
gobject.source_remove(self.checker_callback_tag)
690
self.checker_callback(pid, status,
691
self.current_checker_command)
721
if self.checker is not None and not self.checker.is_alive():
722
logger.warning("Checker was not alive; joining")
723
self.checker.join()
724
self.checker = None
692
725
# Start a new checker if needed
693
726
if self.checker is None:
694
727
# Escape attributes for the shell
695
escaped_attrs = dict(
696
(attr, re.escape(unicode(getattr(self, attr))))
697
for attr in
698
self.runtime_expansions)
728
escaped_attrs = {
729
attr: re.escape(str(getattr(self, attr)))
730
for attr in self.runtime_expansions }
699
731
try:
700
732
command = self.checker_command % escaped_attrs
701
733
except TypeError as error:
702
734
logger.error('Could not format string "%s"',
703
self.checker_command, exc_info=error)
704
return True # Try again later
735
self.checker_command,
736
exc_info=error)
737
return True # Try again later
705
738
self.current_checker_command = command
706
try:
707
logger.info("Starting checker %r for %s",
708
command, self.name)
709
# We don't need to redirect stdout and stderr, since
710
# in normal mode, that is already done by daemon(),
711
# and in debug mode we don't want to. (Stdin is
712
# always replaced by /dev/null.)
713
self.checker = subprocess.Popen(command,
714
close_fds=True,
715
shell=True, cwd="/")
716
except OSError as error:
717
logger.error("Failed to start subprocess",
718
exc_info=error)
719
self.checker_callback_tag = (gobject.child_watch_add
720
(self.checker.pid,
721
self.checker_callback,
722
data=command))
723
# The checker may have completed before the gobject
724
# watch was added. Check for this.
725
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
726
if pid:
727
gobject.source_remove(self.checker_callback_tag)
728
self.checker_callback(pid, status, command)
739
logger.info("Starting checker %r for %s", command,
740
self.name)
741
# We don't need to redirect stdout and stderr, since
742
# in normal mode, that is already done by daemon(),
743
# and in debug mode we don't want to. (Stdin is
744
# always replaced by /dev/null.)
745
# The exception is when not debugging but nevertheless
746
# running in the foreground; use the previously
747
# created wnull.
748
popen_args = { "close_fds": True,
749
"shell": True,
750
"cwd": "/" }
751
if (not self.server_settings["debug"]
752
and self.server_settings["foreground"]):
753
popen_args.update({"stdout": wnull,
754
"stderr": wnull })
755
pipe = multiprocessing.Pipe(duplex = False)
756
self.checker = multiprocessing.Process(
757
target = call_pipe,
758
args = (pipe[1], subprocess.call, command),
759
kwargs = popen_args)
760
self.checker.start()
761
self.checker_callback_tag = gobject.io_add_watch(
762
pipe[0].fileno(), gobject.IO_IN,
763
self.checker_callback, pipe[0], command)
729
764
# Re-run this periodically if run by gobject.timeout_add
730
765
return True
731
766
737
772
if getattr(self, "checker", None) is None:
738
773
return
739
774
logger.debug("Stopping checker for %(name)s", vars(self))
740
try:
741
self.checker.terminate()
742
#time.sleep(0.5)
743
#if self.checker.poll() is None:
744
# self.checker.kill()
745
except OSError as error:
746
if error.errno != errno.ESRCH: # No such process
747
raise
775
self.checker.terminate()
748
776
self.checker = None
749
777
750
778
751
def dbus_service_property(dbus_interface, signature="v",
752
access="readwrite", byte_arrays=False):
779
def dbus_service_property(dbus_interface,
780
signature="v",
781
access="readwrite",
782
byte_arrays=False):
753
783
"""Decorators for marking methods of a DBusObjectWithProperties to
754
784
become properties on the D-Bus.
755
785
764
794
# "Set" method, so we fail early here:
765
795
if byte_arrays and signature != "ay":
766
796
raise ValueError("Byte arrays not supported for non-'ay'"
767
" signature {0!r}".format(signature))
797
" signature {!r}".format(signature))
798
768
799
def decorator(func):
769
800
func._dbus_is_property = True
770
801
func._dbus_interface = dbus_interface
775
806
func._dbus_name = func._dbus_name[:-14]
776
807
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
777
808
return func
809
778
810
return decorator
779
811
780
812
789
821
"org.freedesktop.DBus.Property.EmitsChangedSignal":
790
822
"false"}
791
823
"""
824
792
825
def decorator(func):
793
826
func._dbus_is_interface = True
794
827
func._dbus_interface = dbus_interface
795
828
func._dbus_name = dbus_interface
796
829
return func
830
797
831
return decorator
798
832
799
833
801
835
"""Decorator to annotate D-Bus methods, signals or properties
802
836
Usage:
803
837
838
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
839
"org.freedesktop.DBus.Property."
840
"EmitsChangedSignal": "false"})
804
841
@dbus_service_property("org.example.Interface", signature="b",
805
842
access="r")
806
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
807
"org.freedesktop.DBus.Property."
808
"EmitsChangedSignal": "false"})
809
843
def Property_dbus_property(self):
810
844
return dbus.Boolean(False)
845
846
See also the DBusObjectWithAnnotations class.
811
847
"""
848
812
849
def decorator(func):
813
850
func._dbus_annotations = annotations
814
851
return func
852
815
853
return decorator
816
854
817
855
818
856
class DBusPropertyException(dbus.exceptions.DBusException):
819
857
"""A base class for D-Bus property-related exceptions
820
858
"""
821
def __unicode__(self):
822
return unicode(str(self))
859
pass
823
860
824
861
825
862
class DBusPropertyAccessException(DBusPropertyException):
834
871
pass
835
872
836
873
837
class DBusObjectWithProperties(dbus.service.Object):
838
"""A D-Bus object with properties.
874
class DBusObjectWithAnnotations(dbus.service.Object):
875
"""A D-Bus object with annotations.
839
876
840
Classes inheriting from this can use the dbus_service_property
841
decorator to expose methods as D-Bus properties. It exposes the
842
standard Get(), Set(), and GetAll() methods on the D-Bus.
877
Classes inheriting from this can use the dbus_annotations
878
decorator to add annotations to methods or signals.
843
879
"""
844
880
845
881
@staticmethod
849
885
If called like _is_dbus_thing("method") it returns a function
850
886
suitable for use as predicate to inspect.getmembers().
851
887
"""
852
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
888
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
853
889
False)
854
890
855
891
def _get_all_dbus_things(self, thing):
856
892
"""Returns a generator of (name, attribute) pairs
857
893
"""
858
return ((getattr(athing.__get__(self), "_dbus_name",
859
name),
894
return ((getattr(athing.__get__(self), "_dbus_name", name),
860
895
athing.__get__(self))
861
896
for cls in self.__class__.__mro__
862
897
for name, athing in
863
inspect.getmembers(cls,
864
self._is_dbus_thing(thing)))
898
inspect.getmembers(cls, self._is_dbus_thing(thing)))
899
900
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
901
out_signature = "s",
902
path_keyword = 'object_path',
903
connection_keyword = 'connection')
904
def Introspect(self, object_path, connection):
905
"""Overloading of standard D-Bus method.
906
907
Inserts annotation tags on methods and signals.
908
"""
909
xmlstring = dbus.service.Object.Introspect(self, object_path,
910
connection)
911
try:
912
document = xml.dom.minidom.parseString(xmlstring)
913
914
for if_tag in document.getElementsByTagName("interface"):
915
# Add annotation tags
916
for typ in ("method", "signal"):
917
for tag in if_tag.getElementsByTagName(typ):
918
annots = dict()
919
for name, prop in (self.
920
_get_all_dbus_things(typ)):
921
if (name == tag.getAttribute("name")
922
and prop._dbus_interface
923
== if_tag.getAttribute("name")):
924
annots.update(getattr(
925
prop, "_dbus_annotations", {}))
926
for name, value in annots.items():
927
ann_tag = document.createElement(
928
"annotation")
929
ann_tag.setAttribute("name", name)
930
ann_tag.setAttribute("value", value)
931
tag.appendChild(ann_tag)
932
# Add interface annotation tags
933
for annotation, value in dict(
934
itertools.chain.from_iterable(
935
annotations().items()
936
for name, annotations
937
in self._get_all_dbus_things("interface")
938
if name == if_tag.getAttribute("name")
939
)).items():
940
ann_tag = document.createElement("annotation")
941
ann_tag.setAttribute("name", annotation)
942
ann_tag.setAttribute("value", value)
943
if_tag.appendChild(ann_tag)
944
# Fix argument name for the Introspect method itself
945
if (if_tag.getAttribute("name")
946
== dbus.INTROSPECTABLE_IFACE):
947
for cn in if_tag.getElementsByTagName("method"):
948
if cn.getAttribute("name") == "Introspect":
949
for arg in cn.getElementsByTagName("arg"):
950
if (arg.getAttribute("direction")
951
== "out"):
952
arg.setAttribute("name",
953
"xml_data")
954
xmlstring = document.toxml("utf-8")
955
document.unlink()
956
except (AttributeError, xml.dom.DOMException,
957
xml.parsers.expat.ExpatError) as error:
958
logger.error("Failed to override Introspection method",
959
exc_info=error)
960
return xmlstring
961
962
963
class DBusObjectWithProperties(DBusObjectWithAnnotations):
964
"""A D-Bus object with properties.
965
966
Classes inheriting from this can use the dbus_service_property
967
decorator to expose methods as D-Bus properties. It exposes the
968
standard Get(), Set(), and GetAll() methods on the D-Bus.
969
"""
865
970
866
971
def _get_dbus_property(self, interface_name, property_name):
867
972
"""Returns a bound method if one exists which is a D-Bus
868
973
property with the specified name and interface.
869
974
"""
870
for cls in self.__class__.__mro__:
871
for name, value in (inspect.getmembers
872
(cls,
873
self._is_dbus_thing("property"))):
975
for cls in self.__class__.__mro__:
976
for name, value in inspect.getmembers(
977
cls, self._is_dbus_thing("property")):
874
978
if (value._dbus_name == property_name
875
979
and value._dbus_interface == interface_name):
876
980
return value.__get__(self)
877
981
878
982
# No such property
879
raise DBusPropertyNotFound(self.dbus_object_path + ":"
880
+ interface_name + "."
881
+ property_name)
882
883
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
983
raise DBusPropertyNotFound("{}:{}.{}".format(
984
self.dbus_object_path, interface_name, property_name))
985
986
@classmethod
987
def _get_all_interface_names(cls):
988
"""Get a sequence of all interfaces supported by an object"""
989
return (name for name in set(getattr(getattr(x, attr),
990
"_dbus_interface", None)
991
for x in (inspect.getmro(cls))
992
for attr in dir(x))
993
if name is not None)
994
995
@dbus.service.method(dbus.PROPERTIES_IFACE,
996
in_signature="ss",
884
997
out_signature="v")
885
998
def Get(self, interface_name, property_name):
886
999
"""Standard D-Bus property Get() method, see D-Bus standard.
904
1017
# The byte_arrays option is not supported yet on
905
1018
# signatures other than "ay".
906
1019
if prop._dbus_signature != "ay":
907
raise ValueError
1020
raise ValueError("Byte arrays not supported for non-"
1021
"'ay' signature {!r}"
1022
.format(prop._dbus_signature))
908
1023
value = dbus.ByteArray(b''.join(chr(byte)
909
1024
for byte in value))
910
1025
prop(value)
911
1026
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1027
@dbus.service.method(dbus.PROPERTIES_IFACE,
1028
in_signature="s",
913
1029
out_signature="a{sv}")
914
1030
def GetAll(self, interface_name):
915
1031
"""Standard D-Bus property GetAll() method, see D-Bus
930
1046
if not hasattr(value, "variant_level"):
931
1047
properties[name] = value
932
1048
continue
933
properties[name] = type(value)(value, variant_level=
934
value.variant_level+1)
1049
properties[name] = type(value)(
1050
value, variant_level = value.variant_level + 1)
935
1051
return dbus.Dictionary(properties, signature="sv")
936
1052
1053
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1054
def PropertiesChanged(self, interface_name, changed_properties,
1055
invalidated_properties):
1056
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1057
standard.
1058
"""
1059
pass
1060
937
1061
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
938
1062
out_signature="s",
939
1063
path_keyword='object_path',
943
1067
944
1068
Inserts property tags and interface annotation tags.
945
1069
"""
946
xmlstring = dbus.service.Object.Introspect(self, object_path,
947
connection)
1070
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1071
object_path,
1072
connection)
948
1073
try:
949
1074
document = xml.dom.minidom.parseString(xmlstring)
1075
950
1076
def make_tag(document, name, prop):
951
1077
e = document.createElement("property")
952
1078
e.setAttribute("name", name)
953
1079
e.setAttribute("type", prop._dbus_signature)
954
1080
e.setAttribute("access", prop._dbus_access)
955
1081
return e
1082
956
1083
for if_tag in document.getElementsByTagName("interface"):
957
1084
# Add property tags
958
1085
for tag in (make_tag(document, name, prop)
961
1088
if prop._dbus_interface
962
1089
== if_tag.getAttribute("name")):
963
1090
if_tag.appendChild(tag)
964
# Add annotation tags
965
for typ in ("method", "signal", "property"):
966
for tag in if_tag.getElementsByTagName(typ):
967
annots = dict()
968
for name, prop in (self.
969
_get_all_dbus_things(typ)):
970
if (name == tag.getAttribute("name")
971
and prop._dbus_interface
972
== if_tag.getAttribute("name")):
973
annots.update(getattr
974
(prop,
975
"_dbus_annotations",
976
{}))
977
for name, value in annots.iteritems():
978
ann_tag = document.createElement(
979
"annotation")
980
ann_tag.setAttribute("name", name)
981
ann_tag.setAttribute("value", value)
982
tag.appendChild(ann_tag)
983
# Add interface annotation tags
984
for annotation, value in dict(
985
itertools.chain.from_iterable(
986
annotations().iteritems()
987
for name, annotations in
988
self._get_all_dbus_things("interface")
989
if name == if_tag.getAttribute("name")
990
)).iteritems():
991
ann_tag = document.createElement("annotation")
992
ann_tag.setAttribute("name", annotation)
993
ann_tag.setAttribute("value", value)
994
if_tag.appendChild(ann_tag)
1091
# Add annotation tags for properties
1092
for tag in if_tag.getElementsByTagName("property"):
1093
annots = dict()
1094
for name, prop in self._get_all_dbus_things(
1095
"property"):
1096
if (name == tag.getAttribute("name")
1097
and prop._dbus_interface
1098
== if_tag.getAttribute("name")):
1099
annots.update(getattr(
1100
prop, "_dbus_annotations", {}))
1101
for name, value in annots.items():
1102
ann_tag = document.createElement(
1103
"annotation")
1104
ann_tag.setAttribute("name", name)
1105
ann_tag.setAttribute("value", value)
1106
tag.appendChild(ann_tag)
995
1107
# Add the names to the return values for the
996
1108
# "org.freedesktop.DBus.Properties" methods
997
1109
if (if_tag.getAttribute("name")
1015
1127
exc_info=error)
1016
1128
return xmlstring
1017
1129
1130
try:
1131
dbus.OBJECT_MANAGER_IFACE
1132
except AttributeError:
1133
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1134
1135
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1136
"""A D-Bus object with an ObjectManager.
1137
1138
Classes inheriting from this exposes the standard
1139
GetManagedObjects call and the InterfacesAdded and
1140
InterfacesRemoved signals on the standard
1141
"org.freedesktop.DBus.ObjectManager" interface.
1142
1143
Note: No signals are sent automatically; they must be sent
1144
manually.
1145
"""
1146
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1147
out_signature = "a{oa{sa{sv}}}")
1148
def GetManagedObjects(self):
1149
"""This function must be overridden"""
1150
raise NotImplementedError()
1151
1152
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1153
signature = "oa{sa{sv}}")
1154
def InterfacesAdded(self, object_path, interfaces_and_properties):
1155
pass
1156
1157
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1158
def InterfacesRemoved(self, object_path, interfaces):
1159
pass
1160
1161
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1162
out_signature = "s",
1163
path_keyword = 'object_path',
1164
connection_keyword = 'connection')
1165
def Introspect(self, object_path, connection):
1166
"""Overloading of standard D-Bus method.
1167
1168
Override return argument name of GetManagedObjects to be
1169
"objpath_interfaces_and_properties"
1170
"""
1171
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1172
object_path,
1173
connection)
1174
try:
1175
document = xml.dom.minidom.parseString(xmlstring)
1176
1177
for if_tag in document.getElementsByTagName("interface"):
1178
# Fix argument name for the GetManagedObjects method
1179
if (if_tag.getAttribute("name")
1180
== dbus.OBJECT_MANAGER_IFACE):
1181
for cn in if_tag.getElementsByTagName("method"):
1182
if (cn.getAttribute("name")
1183
== "GetManagedObjects"):
1184
for arg in cn.getElementsByTagName("arg"):
1185
if (arg.getAttribute("direction")
1186
== "out"):
1187
arg.setAttribute(
1188
"name",
1189
"objpath_interfaces"
1190
"_and_properties")
1191
xmlstring = document.toxml("utf-8")
1192
document.unlink()
1193
except (AttributeError, xml.dom.DOMException,
1194
xml.parsers.expat.ExpatError) as error:
1195
logger.error("Failed to override Introspection method",
1196
exc_info = error)
1197
return xmlstring
1018
1198
1019
1199
def datetime_to_dbus(dt, variant_level=0):
1020
1200
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1021
1201
if dt is None:
1022
1202
return dbus.String("", variant_level = variant_level)
1023
return dbus.String(dt.isoformat(),
1024
variant_level=variant_level)
1203
return dbus.String(dt.isoformat(), variant_level=variant_level)
1025
1204
1026
1205
1027
1206
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1047
1226
(from DBusObjectWithProperties) and interfaces (from the
1048
1227
dbus_interface_annotations decorator).
1049
1228
"""
1229
1050
1230
def wrapper(cls):
1051
1231
for orig_interface_name, alt_interface_name in (
1052
alt_interface_names.iteritems()):
1232
alt_interface_names.items()):
1053
1233
attr = {}
1054
1234
interface_names = set()
1055
1235
# Go though all attributes of the class
1057
1237
# Ignore non-D-Bus attributes, and D-Bus attributes
1058
1238
# with the wrong interface name
1059
1239
if (not hasattr(attribute, "_dbus_interface")
1060
or not attribute._dbus_interface
1061
.startswith(orig_interface_name)):
1240
or not attribute._dbus_interface.startswith(
1241
orig_interface_name)):
1062
1242
continue
1063
1243
# Create an alternate D-Bus interface name based on
1064
1244
# the current name
1065
alt_interface = (attribute._dbus_interface
1066
.replace(orig_interface_name,
1067
alt_interface_name))
1245
alt_interface = attribute._dbus_interface.replace(
1246
orig_interface_name, alt_interface_name)
1068
1247
interface_names.add(alt_interface)
1069
1248
# Is this a D-Bus signal?
1070
1249
if getattr(attribute, "_dbus_is_signal", False):
1071
# Extract the original non-method function by
1072
# black magic
1073
nonmethod_func = (dict(
1250
if sys.version_info.major == 2:
1251
# Extract the original non-method undecorated
1252
# function by black magic
1253
nonmethod_func = (dict(
1074
1254
zip(attribute.func_code.co_freevars,
1075
attribute.__closure__))["func"]
1076
.cell_contents)
1255
attribute.__closure__))
1256
["func"].cell_contents)
1257
else:
1258
nonmethod_func = attribute
1077
1259
# Create a new, but exactly alike, function
1078
1260
# object, and decorate it to be a new D-Bus signal
1079
1261
# with the alternate D-Bus interface name
1080
new_function = (dbus.service.signal
1081
(alt_interface,
1082
attribute._dbus_signature)
1083
(types.FunctionType(
1084
nonmethod_func.func_code,
1085
nonmethod_func.func_globals,
1086
nonmethod_func.func_name,
1087
nonmethod_func.func_defaults,
1088
nonmethod_func.func_closure)))
1262
if sys.version_info.major == 2:
1263
new_function = types.FunctionType(
1264
nonmethod_func.func_code,
1265
nonmethod_func.func_globals,
1266
nonmethod_func.func_name,
1267
nonmethod_func.func_defaults,
1268
nonmethod_func.func_closure)
1269
else:
1270
new_function = types.FunctionType(
1271
nonmethod_func.__code__,
1272
nonmethod_func.__globals__,
1273
nonmethod_func.__name__,
1274
nonmethod_func.__defaults__,
1275
nonmethod_func.__closure__)
1276
new_function = (dbus.service.signal(
1277
alt_interface,
1278
attribute._dbus_signature)(new_function))
1089
1279
# Copy annotations, if any
1090
1280
try:
1091
new_function._dbus_annotations = (
1092
dict(attribute._dbus_annotations))
1281
new_function._dbus_annotations = dict(
1282
attribute._dbus_annotations)
1093
1283
except AttributeError:
1094
1284
pass
1095
1285
# Define a creator of a function to call both the
1100
1290
"""This function is a scope container to pass
1101
1291
func1 and func2 to the "call_both" function
1102
1292
outside of its arguments"""
1293
1294
@functools.wraps(func2)
1103
1295
def call_both(*args, **kwargs):
1104
1296
"""This function will emit two D-Bus
1105
1297
signals by calling func1 and func2"""
1106
1298
func1(*args, **kwargs)
1107
1299
func2(*args, **kwargs)
1300
# Make wrapper function look like a D-Bus signal
1301
for name, attr in inspect.getmembers(func2):
1302
if name.startswith("_dbus_"):
1303
setattr(call_both, name, attr)
1304
1108
1305
return call_both
1109
1306
# Create the "call_both" function and add it to
1110
1307
# the class
1115
1312
# object. Decorate it to be a new D-Bus method
1116
1313
# with the alternate D-Bus interface name. Add it
1117
1314
# to the class.
1118
attr[attrname] = (dbus.service.method
1119
(alt_interface,
1120
attribute._dbus_in_signature,
1121
attribute._dbus_out_signature)
1122
(types.FunctionType
1123
(attribute.func_code,
1124
attribute.func_globals,
1125
attribute.func_name,
1126
attribute.func_defaults,
1127
attribute.func_closure)))
1315
attr[attrname] = (
1316
dbus.service.method(
1317
alt_interface,
1318
attribute._dbus_in_signature,
1319
attribute._dbus_out_signature)
1320
(types.FunctionType(attribute.func_code,
1321
attribute.func_globals,
1322
attribute.func_name,
1323
attribute.func_defaults,
1324
attribute.func_closure)))
1128
1325
# Copy annotations, if any
1129
1326
try:
1130
attr[attrname]._dbus_annotations = (
1131
dict(attribute._dbus_annotations))
1327
attr[attrname]._dbus_annotations = dict(
1328
attribute._dbus_annotations)
1132
1329
except AttributeError:
1133
1330
pass
1134
1331
# Is this a D-Bus property?
1137
1334
# object, and decorate it to be a new D-Bus
1138
1335
# property with the alternate D-Bus interface
1139
1336
# name. Add it to the class.
1140
attr[attrname] = (dbus_service_property
1141
(alt_interface,
1142
attribute._dbus_signature,
1143
attribute._dbus_access,
1144
attribute
1145
._dbus_get_args_options
1146
["byte_arrays"])
1147
(types.FunctionType
1148
(attribute.func_code,
1149
attribute.func_globals,
1150
attribute.func_name,
1151
attribute.func_defaults,
1152
attribute.func_closure)))
1337
attr[attrname] = (dbus_service_property(
1338
alt_interface, attribute._dbus_signature,
1339
attribute._dbus_access,
1340
attribute._dbus_get_args_options
1341
["byte_arrays"])
1342
(types.FunctionType(
1343
attribute.func_code,
1344
attribute.func_globals,
1345
attribute.func_name,
1346
attribute.func_defaults,
1347
attribute.func_closure)))
1153
1348
# Copy annotations, if any
1154
1349
try:
1155
attr[attrname]._dbus_annotations = (
1156
dict(attribute._dbus_annotations))
1350
attr[attrname]._dbus_annotations = dict(
1351
attribute._dbus_annotations)
1157
1352
except AttributeError:
1158
1353
pass
1159
1354
# Is this a D-Bus interface?
1162
1357
# object. Decorate it to be a new D-Bus interface
1163
1358
# with the alternate D-Bus interface name. Add it
1164
1359
# to the class.
1165
attr[attrname] = (dbus_interface_annotations
1166
(alt_interface)
1167
(types.FunctionType
1168
(attribute.func_code,
1169
attribute.func_globals,
1170
attribute.func_name,
1171
attribute.func_defaults,
1172
attribute.func_closure)))
1360
attr[attrname] = (
1361
dbus_interface_annotations(alt_interface)
1362
(types.FunctionType(attribute.func_code,
1363
attribute.func_globals,
1364
attribute.func_name,
1365
attribute.func_defaults,
1366
attribute.func_closure)))
1173
1367
if deprecate:
1174
1368
# Deprecate all alternate interfaces
1175
iname="_AlternateDBusNames_interface_annotation{0}"
1369
iname="_AlternateDBusNames_interface_annotation{}"
1176
1370
for interface_name in interface_names:
1371
1177
1372
@dbus_interface_annotations(interface_name)
1178
1373
def func(self):
1179
1374
return { "org.freedesktop.DBus.Deprecated":
1180
"true" }
1375
"true" }
1181
1376
# Find an unused name
1182
1377
for aname in (iname.format(i)
1183
1378
for i in itertools.count()):
1187
1382
if interface_names:
1188
1383
# Replace the class with a new subclass of it with
1189
1384
# methods, signals, etc. as created above.
1190
cls = type(b"{0}Alternate".format(cls.__name__),
1191
(cls,), attr)
1385
cls = type(b"{}Alternate".format(cls.__name__),
1386
(cls, ), attr)
1192
1387
return cls
1388
1193
1389
return wrapper
1194
1390
1195
1391
1196
1392
@alternate_dbus_interfaces({"se.recompile.Mandos":
1197
"se.bsnet.fukt.Mandos"})
1393
"se.bsnet.fukt.Mandos"})
1198
1394
class ClientDBus(Client, DBusObjectWithProperties):
1199
1395
"""A Client class using D-Bus
1200
1396
1204
1400
"""
1205
1401
1206
1402
runtime_expansions = (Client.runtime_expansions
1207
+ ("dbus_object_path",))
1403
+ ("dbus_object_path", ))
1404
1405
_interface = "se.recompile.Mandos.Client"
1208
1406
1209
1407
# dbus.service.Object doesn't use super(), so we can't either.
1210
1408
1213
1411
Client.__init__(self, *args, **kwargs)
1214
1412
# Only now, when this client is initialized, can it show up on
1215
1413
# the D-Bus
1216
client_object_name = unicode(self.name).translate(
1414
client_object_name = str(self.name).translate(
1217
1415
{ord("."): ord("_"),
1218
1416
ord("-"): ord("_")})
1219
self.dbus_object_path = (dbus.ObjectPath
1220
("/clients/" + client_object_name))
1417
self.dbus_object_path = dbus.ObjectPath(
1418
"/clients/" + client_object_name)
1221
1419
DBusObjectWithProperties.__init__(self, self.bus,
1222
1420
self.dbus_object_path)
1223
1421
1224
def notifychangeproperty(transform_func,
1225
dbus_name, type_func=lambda x: x,
1226
variant_level=1):
1422
def notifychangeproperty(transform_func, dbus_name,
1423
type_func=lambda x: x,
1424
variant_level=1,
1425
invalidate_only=False,
1426
_interface=_interface):
1227
1427
""" Modify a variable so that it's a property which announces
1228
1428
its changes to DBus.
1229
1429
1234
1434
to the D-Bus. Default: no transform
1235
1435
variant_level: D-Bus variant level. Default: 1
1236
1436
"""
1237
attrname = "_{0}".format(dbus_name)
1437
attrname = "_{}".format(dbus_name)
1438
1238
1439
def setter(self, value):
1239
1440
if hasattr(self, "dbus_object_path"):
1240
1441
if (not hasattr(self, attrname) or
1241
1442
type_func(getattr(self, attrname, None))
1242
1443
!= type_func(value)):
1243
dbus_value = transform_func(type_func(value),
1244
variant_level
1245
=variant_level)
1246
self.PropertyChanged(dbus.String(dbus_name),
1247
dbus_value)
1444
if invalidate_only:
1445
self.PropertiesChanged(
1446
_interface, dbus.Dictionary(),
1447
dbus.Array((dbus_name, )))
1448
else:
1449
dbus_value = transform_func(
1450
type_func(value),
1451
variant_level = variant_level)
1452
self.PropertyChanged(dbus.String(dbus_name),
1453
dbus_value)
1454
self.PropertiesChanged(
1455
_interface,
1456
dbus.Dictionary({ dbus.String(dbus_name):
1457
dbus_value }),
1458
dbus.Array())
1248
1459
setattr(self, attrname, value)
1249
1460
1250
1461
return property(lambda self: getattr(self, attrname), setter)
1256
1467
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1257
1468
last_enabled = notifychangeproperty(datetime_to_dbus,
1258
1469
"LastEnabled")
1259
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1260
type_func = lambda checker:
1261
checker is not None)
1470
checker = notifychangeproperty(
1471
dbus.Boolean, "CheckerRunning",
1472
type_func = lambda checker: checker is not None)
1262
1473
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1263
1474
"LastCheckedOK")
1264
1475
last_checker_status = notifychangeproperty(dbus.Int16,
1267
1478
datetime_to_dbus, "LastApprovalRequest")
1268
1479
approved_by_default = notifychangeproperty(dbus.Boolean,
1269
1480
"ApprovedByDefault")
1270
approval_delay = notifychangeproperty(dbus.UInt64,
1271
"ApprovalDelay",
1272
type_func =
1273
timedelta_to_milliseconds)
1481
approval_delay = notifychangeproperty(
1482
dbus.UInt64, "ApprovalDelay",
1483
type_func = lambda td: td.total_seconds() * 1000)
1274
1484
approval_duration = notifychangeproperty(
1275
1485
dbus.UInt64, "ApprovalDuration",
1276
type_func = timedelta_to_milliseconds)
1486
type_func = lambda td: td.total_seconds() * 1000)
1277
1487
host = notifychangeproperty(dbus.String, "Host")
1278
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1279
type_func =
1280
timedelta_to_milliseconds)
1488
timeout = notifychangeproperty(
1489
dbus.UInt64, "Timeout",
1490
type_func = lambda td: td.total_seconds() * 1000)
1281
1491
extended_timeout = notifychangeproperty(
1282
1492
dbus.UInt64, "ExtendedTimeout",
1283
type_func = timedelta_to_milliseconds)
1284
interval = notifychangeproperty(dbus.UInt64,
1285
"Interval",
1286
type_func =
1287
timedelta_to_milliseconds)
1493
type_func = lambda td: td.total_seconds() * 1000)
1494
interval = notifychangeproperty(
1495
dbus.UInt64, "Interval",
1496
type_func = lambda td: td.total_seconds() * 1000)
1288
1497
checker_command = notifychangeproperty(dbus.String, "Checker")
1498
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1499
invalidate_only=True)
1289
1500
1290
1501
del notifychangeproperty
1291
1502
1298
1509
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1299
1510
Client.__del__(self, *args, **kwargs)
1300
1511
1301
def checker_callback(self, pid, condition, command,
1302
*args, **kwargs):
1303
self.checker_callback_tag = None
1304
self.checker = None
1305
if os.WIFEXITED(condition):
1306
exitstatus = os.WEXITSTATUS(condition)
1512
def checker_callback(self, source, condition,
1513
connection, command, *args, **kwargs):
1514
ret = Client.checker_callback(self, source, condition,
1515
connection, command, *args,
1516
**kwargs)
1517
exitstatus = self.last_checker_status
1518
if exitstatus >= 0:
1307
1519
# Emit D-Bus signal
1308
1520
self.CheckerCompleted(dbus.Int16(exitstatus),
1309
dbus.Int64(condition),
1521
# This is specific to GNU libC
1522
dbus.Int64(exitstatus << 8),
1310
1523
dbus.String(command))
1311
1524
else:
1312
1525
# Emit D-Bus signal
1313
1526
self.CheckerCompleted(dbus.Int16(-1),
1314
dbus.Int64(condition),
1527
dbus.Int64(
1528
# This is specific to GNU libC
1529
(exitstatus << 8)
1530
| self.last_checker_signal),
1315
1531
dbus.String(command))
1316
1317
return Client.checker_callback(self, pid, condition, command,
1318
*args, **kwargs)
1532
return ret
1319
1533
1320
1534
def start_checker(self, *args, **kwargs):
1321
old_checker = self.checker
1322
if self.checker is not None:
1323
old_checker_pid = self.checker.pid
1324
else:
1325
old_checker_pid = None
1535
old_checker_pid = getattr(self.checker, "pid", None)
1326
1536
r = Client.start_checker(self, *args, **kwargs)
1327
1537
# Only if new checker process was started
1328
1538
if (self.checker is not None
1337
1547
1338
1548
def approve(self, value=True):
1339
1549
self.approved = value
1340
gobject.timeout_add(timedelta_to_milliseconds
1341
(self.approval_duration),
1342
self._reset_approved)
1550
gobject.timeout_add(int(self.approval_duration.total_seconds()
1551
* 1000), self._reset_approved)
1343
1552
self.send_changedstate()
1344
1553
1345
1554
## D-Bus methods, signals & properties
1346
_interface = "se.recompile.Mandos.Client"
1347
1555
1348
1556
## Interfaces
1349
1557
1350
@dbus_interface_annotations(_interface)
1351
def _foo(self):
1352
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1353
"false"}
1354
1355
1558
## Signals
1356
1559
1357
1560
# CheckerCompleted - signal
1367
1570
pass
1368
1571
1369
1572
# PropertyChanged - signal
1573
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1370
1574
@dbus.service.signal(_interface, signature="sv")
1371
1575
def PropertyChanged(self, property, value):
1372
1576
"D-Bus signal"
1406
1610
self.checked_ok()
1407
1611
1408
1612
# Enable - method
1613
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1409
1614
@dbus.service.method(_interface)
1410
1615
def Enable(self):
1411
1616
"D-Bus method"
1412
1617
self.enable()
1413
1618
1414
1619
# StartChecker - method
1620
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1415
1621
@dbus.service.method(_interface)
1416
1622
def StartChecker(self):
1417
1623
"D-Bus method"
1418
1624
self.start_checker()
1419
1625
1420
1626
# Disable - method
1627
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1421
1628
@dbus.service.method(_interface)
1422
1629
def Disable(self):
1423
1630
"D-Bus method"
1424
1631
self.disable()
1425
1632
1426
1633
# StopChecker - method
1634
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1427
1635
@dbus.service.method(_interface)
1428
1636
def StopChecker(self):
1429
1637
self.stop_checker()
1436
1644
return dbus.Boolean(bool(self.approvals_pending))
1437
1645
1438
1646
# ApprovedByDefault - property
1439
@dbus_service_property(_interface, signature="b",
1647
@dbus_service_property(_interface,
1648
signature="b",
1440
1649
access="readwrite")
1441
1650
def ApprovedByDefault_dbus_property(self, value=None):
1442
1651
if value is None: # get
1444
1653
self.approved_by_default = bool(value)
1445
1654
1446
1655
# ApprovalDelay - property
1447
@dbus_service_property(_interface, signature="t",
1656
@dbus_service_property(_interface,
1657
signature="t",
1448
1658
access="readwrite")
1449
1659
def ApprovalDelay_dbus_property(self, value=None):
1450
1660
if value is None: # get
1451
return dbus.UInt64(self.approval_delay_milliseconds())
1661
return dbus.UInt64(self.approval_delay.total_seconds()
1662
* 1000)
1452
1663
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1453
1664
1454
1665
# ApprovalDuration - property
1455
@dbus_service_property(_interface, signature="t",
1666
@dbus_service_property(_interface,
1667
signature="t",
1456
1668
access="readwrite")
1457
1669
def ApprovalDuration_dbus_property(self, value=None):
1458
1670
if value is None: # get
1459
return dbus.UInt64(timedelta_to_milliseconds(
1460
self.approval_duration))
1671
return dbus.UInt64(self.approval_duration.total_seconds()
1672
* 1000)
1461
1673
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1462
1674
1463
1675
# Name - property
1676
@dbus_annotations(
1677
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1464
1678
@dbus_service_property(_interface, signature="s", access="read")
1465
1679
def Name_dbus_property(self):
1466
1680
return dbus.String(self.name)
1467
1681
1468
1682
# Fingerprint - property
1683
@dbus_annotations(
1684
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1469
1685
@dbus_service_property(_interface, signature="s", access="read")
1470
1686
def Fingerprint_dbus_property(self):
1471
1687
return dbus.String(self.fingerprint)
1472
1688
1473
1689
# Host - property
1474
@dbus_service_property(_interface, signature="s",
1690
@dbus_service_property(_interface,
1691
signature="s",
1475
1692
access="readwrite")
1476
1693
def Host_dbus_property(self, value=None):
1477
1694
if value is None: # get
1478
1695
return dbus.String(self.host)
1479
self.host = unicode(value)
1696
self.host = str(value)
1480
1697
1481
1698
# Created - property
1699
@dbus_annotations(
1700
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1482
1701
@dbus_service_property(_interface, signature="s", access="read")
1483
1702
def Created_dbus_property(self):
1484
1703
return datetime_to_dbus(self.created)
1489
1708
return datetime_to_dbus(self.last_enabled)
1490
1709
1491
1710
# Enabled - property
1492
@dbus_service_property(_interface, signature="b",
1711
@dbus_service_property(_interface,
1712
signature="b",
1493
1713
access="readwrite")
1494
1714
def Enabled_dbus_property(self, value=None):
1495
1715
if value is None: # get
1500
1720
self.disable()
1501
1721
1502
1722
# LastCheckedOK - property
1503
@dbus_service_property(_interface, signature="s",
1723
@dbus_service_property(_interface,
1724
signature="s",
1504
1725
access="readwrite")
1505
1726
def LastCheckedOK_dbus_property(self, value=None):
1506
1727
if value is not None:
1509
1730
return datetime_to_dbus(self.last_checked_ok)
1510
1731
1511
1732
# LastCheckerStatus - property
1512
@dbus_service_property(_interface, signature="n",
1513
access="read")
1733
@dbus_service_property(_interface, signature="n", access="read")
1514
1734
def LastCheckerStatus_dbus_property(self):
1515
1735
return dbus.Int16(self.last_checker_status)
1516
1736
1525
1745
return datetime_to_dbus(self.last_approval_request)
1526
1746
1527
1747
# Timeout - property
1528
@dbus_service_property(_interface, signature="t",
1748
@dbus_service_property(_interface,
1749
signature="t",
1529
1750
access="readwrite")
1530
1751
def Timeout_dbus_property(self, value=None):
1531
1752
if value is None: # get
1532
return dbus.UInt64(self.timeout_milliseconds())
1753
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1533
1754
old_timeout = self.timeout
1534
1755
self.timeout = datetime.timedelta(0, 0, 0, value)
1535
1756
# Reschedule disabling
1544
1765
is None):
1545
1766
return
1546
1767
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (
1548
gobject.timeout_add(
1549
timedelta_to_milliseconds(self.expires - now),
1550
self.disable))
1768
self.disable_initiator_tag = gobject.timeout_add(
1769
int((self.expires - now).total_seconds() * 1000),
1770
self.disable)
1551
1771
1552
1772
# ExtendedTimeout - property
1553
@dbus_service_property(_interface, signature="t",
1773
@dbus_service_property(_interface,
1774
signature="t",
1554
1775
access="readwrite")
1555
1776
def ExtendedTimeout_dbus_property(self, value=None):
1556
1777
if value is None: # get
1557
return dbus.UInt64(self.extended_timeout_milliseconds())
1778
return dbus.UInt64(self.extended_timeout.total_seconds()
1779
* 1000)
1558
1780
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1559
1781
1560
1782
# Interval - property
1561
@dbus_service_property(_interface, signature="t",
1783
@dbus_service_property(_interface,
1784
signature="t",
1562
1785
access="readwrite")
1563
1786
def Interval_dbus_property(self, value=None):
1564
1787
if value is None: # get
1565
return dbus.UInt64(self.interval_milliseconds())
1788
return dbus.UInt64(self.interval.total_seconds() * 1000)
1566
1789
self.interval = datetime.timedelta(0, 0, 0, value)
1567
1790
if getattr(self, "checker_initiator_tag", None) is None:
1568
1791
return
1569
1792
if self.enabled:
1570
1793
# Reschedule checker run
1571
1794
gobject.source_remove(self.checker_initiator_tag)
1572
self.checker_initiator_tag = (gobject.timeout_add
1573
(value, self.start_checker))
1574
self.start_checker() # Start one now, too
1795
self.checker_initiator_tag = gobject.timeout_add(
1796
value, self.start_checker)
1797
self.start_checker() # Start one now, too
1575
1798
1576
1799
# Checker - property
1577
@dbus_service_property(_interface, signature="s",
1800
@dbus_service_property(_interface,
1801
signature="s",
1578
1802
access="readwrite")
1579
1803
def Checker_dbus_property(self, value=None):
1580
1804
if value is None: # get
1581
1805
return dbus.String(self.checker_command)
1582
self.checker_command = unicode(value)
1806
self.checker_command = str(value)
1583
1807
1584
1808
# CheckerRunning - property
1585
@dbus_service_property(_interface, signature="b",
1809
@dbus_service_property(_interface,
1810
signature="b",
1586
1811
access="readwrite")
1587
1812
def CheckerRunning_dbus_property(self, value=None):
1588
1813
if value is None: # get
1593
1818
self.stop_checker()
1594
1819
1595
1820
# ObjectPath - property
1821
@dbus_annotations(
1822
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
1823
"org.freedesktop.DBus.Deprecated": "true"})
1596
1824
@dbus_service_property(_interface, signature="o", access="read")
1597
1825
def ObjectPath_dbus_property(self):
1598
1826
return self.dbus_object_path # is already a dbus.ObjectPath
1599
1827
1600
1828
# Secret = property
1601
@dbus_service_property(_interface, signature="ay",
1602
access="write", byte_arrays=True)
1829
@dbus_annotations(
1830
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
1831
"invalidates"})
1832
@dbus_service_property(_interface,
1833
signature="ay",
1834
access="write",
1835
byte_arrays=True)
1603
1836
def Secret_dbus_property(self, value):
1604
self.secret = str(value)
1837
self.secret = bytes(value)
1605
1838
1606
1839
del _interface
1607
1840
1611
1844
self._pipe = child_pipe
1612
1845
self._pipe.send(('init', fpr, address))
1613
1846
if not self._pipe.recv():
1614
raise KeyError()
1847
raise KeyError(fpr)
1615
1848
1616
1849
def __getattribute__(self, name):
1617
1850
if name == '_pipe':
1621
1854
if data[0] == 'data':
1622
1855
return data[1]
1623
1856
if data[0] == 'function':
1857
1624
1858
def func(*args, **kwargs):
1625
1859
self._pipe.send(('funcall', name, args, kwargs))
1626
1860
return self._pipe.recv()[1]
1861
1627
1862
return func
1628
1863
1629
1864
def __setattr__(self, name, value):
1641
1876
def handle(self):
1642
1877
with contextlib.closing(self.server.child_pipe) as child_pipe:
1643
1878
logger.info("TCP connection from: %s",
1644
unicode(self.client_address))
1879
str(self.client_address))
1645
1880
logger.debug("Pipe FD: %d",
1646
1881
self.server.child_pipe.fileno())
1647
1882
1648
session = (gnutls.connection
1649
.ClientSession(self.request,
1650
gnutls.connection
1651
.X509Credentials()))
1883
session = gnutls.connection.ClientSession(
1884
self.request, gnutls.connection .X509Credentials())
1652
1885
1653
1886
# Note: gnutls.connection.X509Credentials is really a
1654
1887
# generic GnuTLS certificate credentials object so long as
1663
1896
priority = self.server.gnutls_priority
1664
1897
if priority is None:
1665
1898
priority = "NORMAL"
1666
(gnutls.library.functions
1667
.gnutls_priority_set_direct(session._c_object,
1668
priority, None))
1899
gnutls.library.functions.gnutls_priority_set_direct(
1900
session._c_object, priority, None)
1669
1901
1670
1902
# Start communication using the Mandos protocol
1671
1903
# Get protocol number
1673
1905
logger.debug("Protocol version: %r", line)
1674
1906
try:
1675
1907
if int(line.strip().split()[0]) > 1:
1676
raise RuntimeError
1908
raise RuntimeError(line)
1677
1909
except (ValueError, IndexError, RuntimeError) as error:
1678
1910
logger.error("Unknown protocol version: %s", error)
1679
1911
return
1691
1923
approval_required = False
1692
1924
try:
1693
1925
try:
1694
fpr = self.fingerprint(self.peer_certificate
1695
(session))
1926
fpr = self.fingerprint(
1927
self.peer_certificate(session))
1696
1928
except (TypeError,
1697
1929
gnutls.errors.GNUTLSError) as error:
1698
1930
logger.warning("Bad certificate: %s", error)
1713
1945
while True:
1714
1946
if not client.enabled:
1715
1947
logger.info("Client %s is disabled",
1716
client.name)
1948
client.name)
1717
1949
if self.server.use_dbus:
1718
1950
# Emit D-Bus signal
1719
1951
client.Rejected("Disabled")
1728
1960
if self.server.use_dbus:
1729
1961
# Emit D-Bus signal
1730
1962
client.NeedApproval(
1731
client.approval_delay_milliseconds(),
1732
client.approved_by_default)
1963
client.approval_delay.total_seconds()
1964
* 1000, client.approved_by_default)
1733
1965
else:
1734
1966
logger.warning("Client %s was not approved",
1735
1967
client.name)
1741
1973
#wait until timeout or approved
1742
1974
time = datetime.datetime.now()
1743
1975
client.changedstate.acquire()
1744
client.changedstate.wait(
1745
float(timedelta_to_milliseconds(delay)
1746
/ 1000))
1976
client.changedstate.wait(delay.total_seconds())
1747
1977
client.changedstate.release()
1748
1978
time2 = datetime.datetime.now()
1749
1979
if (time2 - time) >= delay:
1768
1998
logger.warning("gnutls send failed",
1769
1999
exc_info=error)
1770
2000
return
1771
logger.debug("Sent: %d, remaining: %d",
1772
sent, len(client.secret)
1773
- (sent_size + sent))
2001
logger.debug("Sent: %d, remaining: %d", sent,
2002
len(client.secret) - (sent_size
2003
+ sent))
1774
2004
sent_size += sent
1775
2005
1776
2006
logger.info("Sending secret to %s", client.name)
1793
2023
def peer_certificate(session):
1794
2024
"Return the peer's OpenPGP certificate as a bytestring"
1795
2025
# If not an OpenPGP certificate...
1796
if (gnutls.library.functions
1797
.gnutls_certificate_type_get(session._c_object)
2026
if (gnutls.library.functions.gnutls_certificate_type_get(
2027
session._c_object)
1798
2028
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1799
2029
# ...do the normal thing
1800
2030
return session.peer_certificate
1814
2044
def fingerprint(openpgp):
1815
2045
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1816
2046
# New GnuTLS "datum" with the OpenPGP public key
1817
datum = (gnutls.library.types
1818
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1819
ctypes.POINTER
1820
(ctypes.c_ubyte)),
1821
ctypes.c_uint(len(openpgp))))
2047
datum = gnutls.library.types.gnutls_datum_t(
2048
ctypes.cast(ctypes.c_char_p(openpgp),
2049
ctypes.POINTER(ctypes.c_ubyte)),
2050
ctypes.c_uint(len(openpgp)))
1822
2051
# New empty GnuTLS certificate
1823
2052
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1824
(gnutls.library.functions
1825
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2053
gnutls.library.functions.gnutls_openpgp_crt_init(
2054
ctypes.byref(crt))
1826
2055
# Import the OpenPGP public key into the certificate
1827
(gnutls.library.functions
1828
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1829
gnutls.library.constants
1830
.GNUTLS_OPENPGP_FMT_RAW))
2056
gnutls.library.functions.gnutls_openpgp_crt_import(
2057
crt, ctypes.byref(datum),
2058
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1831
2059
# Verify the self signature in the key
1832
2060
crtverify = ctypes.c_uint()
1833
(gnutls.library.functions
1834
.gnutls_openpgp_crt_verify_self(crt, 0,
1835
ctypes.byref(crtverify)))
2061
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
2062
crt, 0, ctypes.byref(crtverify))
1836
2063
if crtverify.value != 0:
1837
2064
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1838
raise (gnutls.errors.CertificateSecurityError
1839
("Verify failed"))
2065
raise gnutls.errors.CertificateSecurityError(
2066
"Verify failed")
1840
2067
# New buffer for the fingerprint
1841
2068
buf = ctypes.create_string_buffer(20)
1842
2069
buf_len = ctypes.c_size_t()
1843
2070
# Get the fingerprint from the certificate into the buffer
1844
(gnutls.library.functions
1845
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1846
ctypes.byref(buf_len)))
2071
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
2072
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1847
2073
# Deinit the certificate
1848
2074
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1849
2075
# Convert the buffer to a Python bytestring
1855
2081
1856
2082
class MultiprocessingMixIn(object):
1857
2083
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2084
1858
2085
def sub_process_main(self, request, address):
1859
2086
try:
1860
2087
self.finish_request(request, address)
1872
2099
1873
2100
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1874
2101
""" adds a pipe to the MixIn """
2102
1875
2103
def process_request(self, request, client_address):
1876
2104
"""Overrides and wraps the original process_request().
1877
2105
1886
2114
1887
2115
def add_pipe(self, parent_pipe, proc):
1888
2116
"""Dummy function; override as necessary"""
1889
raise NotImplementedError
2117
raise NotImplementedError()
1890
2118
1891
2119
1892
2120
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1898
2126
interface: None or a network interface name (string)
1899
2127
use_ipv6: Boolean; to use IPv6 or not
1900
2128
"""
2129
1901
2130
def __init__(self, server_address, RequestHandlerClass,
1902
interface=None, use_ipv6=True):
2131
interface=None,
2132
use_ipv6=True,
2133
socketfd=None):
2134
"""If socketfd is set, use that file descriptor instead of
2135
creating a new one with socket.socket().
2136
"""
1903
2137
self.interface = interface
1904
2138
if use_ipv6:
1905
2139
self.address_family = socket.AF_INET6
2140
if socketfd is not None:
2141
# Save the file descriptor
2142
self.socketfd = socketfd
2143
# Save the original socket.socket() function
2144
self.socket_socket = socket.socket
2145
# To implement --socket, we monkey patch socket.socket.
2146
#
2147
# (When socketserver.TCPServer is a new-style class, we
2148
# could make self.socket into a property instead of monkey
2149
# patching socket.socket.)
2150
#
2151
# Create a one-time-only replacement for socket.socket()
2152
@functools.wraps(socket.socket)
2153
def socket_wrapper(*args, **kwargs):
2154
# Restore original function so subsequent calls are
2155
# not affected.
2156
socket.socket = self.socket_socket
2157
del self.socket_socket
2158
# This time only, return a new socket object from the
2159
# saved file descriptor.
2160
return socket.fromfd(self.socketfd, *args, **kwargs)
2161
# Replace socket.socket() function with wrapper
2162
socket.socket = socket_wrapper
2163
# The socketserver.TCPServer.__init__ will call
2164
# socket.socket(), which might be our replacement,
2165
# socket_wrapper(), if socketfd was set.
1906
2166
socketserver.TCPServer.__init__(self, server_address,
1907
2167
RequestHandlerClass)
2168
1908
2169
def server_bind(self):
1909
2170
"""This overrides the normal server_bind() function
1910
2171
to bind to an interface if one was specified, and also NOT to
1916
2177
self.interface)
1917
2178
else:
1918
2179
try:
1919
self.socket.setsockopt(socket.SOL_SOCKET,
1920
SO_BINDTODEVICE,
1921
str(self.interface
1922
+ '\0'))
2180
self.socket.setsockopt(
2181
socket.SOL_SOCKET, SO_BINDTODEVICE,
2182
(self.interface + "\0").encode("utf-8"))
1923
2183
except socket.error as error:
1924
2184
if error.errno == errno.EPERM:
1925
logger.error("No permission to"
1926
" bind to interface %s",
1927
self.interface)
2185
logger.error("No permission to bind to"
2186
" interface %s", self.interface)
1928
2187
elif error.errno == errno.ENOPROTOOPT:
1929
2188
logger.error("SO_BINDTODEVICE not available;"
1930
2189
" cannot bind to interface %s",
1931
2190
self.interface)
1932
2191
elif error.errno == errno.ENODEV:
1933
logger.error("Interface %s does not"
1934
" exist, cannot bind",
1935
self.interface)
2192
logger.error("Interface %s does not exist,"
2193
" cannot bind", self.interface)
1936
2194
else:
1937
2195
raise
1938
2196
# Only bind(2) the socket if we really need to.
1941
2199
if self.address_family == socket.AF_INET6:
1942
2200
any_address = "::" # in6addr_any
1943
2201
else:
1944
any_address = socket.INADDR_ANY
2202
any_address = "0.0.0.0" # INADDR_ANY
1945
2203
self.server_address = (any_address,
1946
2204
self.server_address[1])
1947
2205
elif not self.server_address[1]:
1948
self.server_address = (self.server_address[0],
1949
0)
2206
self.server_address = (self.server_address[0], 0)
1950
2207
# if self.interface:
1951
2208
# self.server_address = (self.server_address[0],
1952
2209
# 0, # port
1966
2223
1967
2224
Assumes a gobject.MainLoop event loop.
1968
2225
"""
2226
1969
2227
def __init__(self, server_address, RequestHandlerClass,
1970
interface=None, use_ipv6=True, clients=None,
1971
gnutls_priority=None, use_dbus=True):
2228
interface=None,
2229
use_ipv6=True,
2230
clients=None,
2231
gnutls_priority=None,
2232
use_dbus=True,
2233
socketfd=None):
1972
2234
self.enabled = False
1973
2235
self.clients = clients
1974
2236
if self.clients is None:
1978
2240
IPv6_TCPServer.__init__(self, server_address,
1979
2241
RequestHandlerClass,
1980
2242
interface = interface,
1981
use_ipv6 = use_ipv6)
2243
use_ipv6 = use_ipv6,
2244
socketfd = socketfd)
2245
1982
2246
def server_activate(self):
1983
2247
if self.enabled:
1984
2248
return socketserver.TCPServer.server_activate(self)
1988
2252
1989
2253
def add_pipe(self, parent_pipe, proc):
1990
2254
# Call "handle_ipc" for both data and EOF events
1991
gobject.io_add_watch(parent_pipe.fileno(),
1992
gobject.IO_IN | gobject.IO_HUP,
1993
functools.partial(self.handle_ipc,
1994
parent_pipe =
1995
parent_pipe,
1996
proc = proc))
2255
gobject.io_add_watch(
2256
parent_pipe.fileno(),
2257
gobject.IO_IN | gobject.IO_HUP,
2258
functools.partial(self.handle_ipc,
2259
parent_pipe = parent_pipe,
2260
proc = proc))
1997
2261
1998
def handle_ipc(self, source, condition, parent_pipe=None,
1999
proc = None, client_object=None):
2262
def handle_ipc(self, source, condition,
2263
parent_pipe=None,
2264
proc = None,
2265
client_object=None):
2000
2266
# error, or the other end of multiprocessing.Pipe has closed
2001
2267
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2002
2268
# Wait for other process to exit
2025
2291
parent_pipe.send(False)
2026
2292
return False
2027
2293
2028
gobject.io_add_watch(parent_pipe.fileno(),
2029
gobject.IO_IN | gobject.IO_HUP,
2030
functools.partial(self.handle_ipc,
2031
parent_pipe =
2032
parent_pipe,
2033
proc = proc,
2034
client_object =
2035
client))
2294
gobject.io_add_watch(
2295
parent_pipe.fileno(),
2296
gobject.IO_IN | gobject.IO_HUP,
2297
functools.partial(self.handle_ipc,
2298
parent_pipe = parent_pipe,
2299
proc = proc,
2300
client_object = client))
2036
2301
parent_pipe.send(True)
2037
2302
# remove the old hook in favor of the new above hook on
2038
2303
# same fileno
2044
2309
2045
2310
parent_pipe.send(('data', getattr(client_object,
2046
2311
funcname)(*args,
2047
**kwargs)))
2312
**kwargs)))
2048
2313
2049
2314
if command == 'getattr':
2050
2315
attrname = request[1]
2051
if callable(client_object.__getattribute__(attrname)):
2052
parent_pipe.send(('function',))
2316
if isinstance(client_object.__getattribute__(attrname),
2317
collections.Callable):
2318
parent_pipe.send(('function', ))
2053
2319
else:
2054
parent_pipe.send(('data', client_object
2055
.__getattribute__(attrname)))
2320
parent_pipe.send((
2321
'data', client_object.__getattribute__(attrname)))
2056
2322
2057
2323
if command == 'setattr':
2058
2324
attrname = request[1]
2062
2328
return True
2063
2329
2064
2330
2331
def rfc3339_duration_to_delta(duration):
2332
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2333
2334
>>> rfc3339_duration_to_delta("P7D")
2335
datetime.timedelta(7)
2336
>>> rfc3339_duration_to_delta("PT60S")
2337
datetime.timedelta(0, 60)
2338
>>> rfc3339_duration_to_delta("PT60M")
2339
datetime.timedelta(0, 3600)
2340
>>> rfc3339_duration_to_delta("PT24H")
2341
datetime.timedelta(1)
2342
>>> rfc3339_duration_to_delta("P1W")
2343
datetime.timedelta(7)
2344
>>> rfc3339_duration_to_delta("PT5M30S")
2345
datetime.timedelta(0, 330)
2346
>>> rfc3339_duration_to_delta("P1DT3M20S")
2347
datetime.timedelta(1, 200)
2348
"""
2349
2350
# Parsing an RFC 3339 duration with regular expressions is not
2351
# possible - there would have to be multiple places for the same
2352
# values, like seconds. The current code, while more esoteric, is
2353
# cleaner without depending on a parsing library. If Python had a
2354
# built-in library for parsing we would use it, but we'd like to
2355
# avoid excessive use of external libraries.
2356
2357
# New type for defining tokens, syntax, and semantics all-in-one
2358
Token = collections.namedtuple("Token", (
2359
"regexp", # To match token; if "value" is not None, must have
2360
# a "group" containing digits
2361
"value", # datetime.timedelta or None
2362
"followers")) # Tokens valid after this token
2363
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2364
# the "duration" ABNF definition in RFC 3339, Appendix A.
2365
token_end = Token(re.compile(r"$"), None, frozenset())
2366
token_second = Token(re.compile(r"(\d+)S"),
2367
datetime.timedelta(seconds=1),
2368
frozenset((token_end, )))
2369
token_minute = Token(re.compile(r"(\d+)M"),
2370
datetime.timedelta(minutes=1),
2371
frozenset((token_second, token_end)))
2372
token_hour = Token(re.compile(r"(\d+)H"),
2373
datetime.timedelta(hours=1),
2374
frozenset((token_minute, token_end)))
2375
token_time = Token(re.compile(r"T"),
2376
None,
2377
frozenset((token_hour, token_minute,
2378
token_second)))
2379
token_day = Token(re.compile(r"(\d+)D"),
2380
datetime.timedelta(days=1),
2381
frozenset((token_time, token_end)))
2382
token_month = Token(re.compile(r"(\d+)M"),
2383
datetime.timedelta(weeks=4),
2384
frozenset((token_day, token_end)))
2385
token_year = Token(re.compile(r"(\d+)Y"),
2386
datetime.timedelta(weeks=52),
2387
frozenset((token_month, token_end)))
2388
token_week = Token(re.compile(r"(\d+)W"),
2389
datetime.timedelta(weeks=1),
2390
frozenset((token_end, )))
2391
token_duration = Token(re.compile(r"P"), None,
2392
frozenset((token_year, token_month,
2393
token_day, token_time,
2394
token_week)))
2395
# Define starting values
2396
value = datetime.timedelta() # Value so far
2397
found_token = None
2398
followers = frozenset((token_duration, )) # Following valid tokens
2399
s = duration # String left to parse
2400
# Loop until end token is found
2401
while found_token is not token_end:
2402
# Search for any currently valid tokens
2403
for token in followers:
2404
match = token.regexp.match(s)
2405
if match is not None:
2406
# Token found
2407
if token.value is not None:
2408
# Value found, parse digits
2409
factor = int(match.group(1), 10)
2410
# Add to value so far
2411
value += factor * token.value
2412
# Strip token from string
2413
s = token.regexp.sub("", s, 1)
2414
# Go to found token
2415
found_token = token
2416
# Set valid next tokens
2417
followers = found_token.followers
2418
break
2419
else:
2420
# No currently valid tokens were found
2421
raise ValueError("Invalid RFC 3339 duration: {!r}"
2422
.format(duration))
2423
# End token found
2424
return value
2425
2426
2065
2427
def string_to_delta(interval):
2066
2428
"""Parse a string and return a datetime.timedelta
2067
2429
2078
2440
>>> string_to_delta('5m 30s')
2079
2441
datetime.timedelta(0, 330)
2080
2442
"""
2443
2444
try:
2445
return rfc3339_duration_to_delta(interval)
2446
except ValueError:
2447
pass
2448
2081
2449
timevalue = datetime.timedelta(0)
2082
2450
for s in interval.split():
2083
2451
try:
2084
suffix = unicode(s[-1])
2452
suffix = s[-1]
2085
2453
value = int(s[:-1])
2086
2454
if suffix == "d":
2087
2455
delta = datetime.timedelta(value)
2094
2462
elif suffix == "w":
2095
2463
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2096
2464
else:
2097
raise ValueError("Unknown suffix {0!r}"
2098
.format(suffix))
2099
except (ValueError, IndexError) as e:
2465
raise ValueError("Unknown suffix {!r}".format(suffix))
2466
except IndexError as e:
2100
2467
raise ValueError(*(e.args))
2101
2468
timevalue += delta
2102
2469
return timevalue
2118
2485
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2119
2486
if not stat.S_ISCHR(os.fstat(null).st_mode):
2120
2487
raise OSError(errno.ENODEV,
2121
"{0} not a character device"
2488
"{} not a character device"
2122
2489
.format(os.devnull))
2123
2490
os.dup2(null, sys.stdin.fileno())
2124
2491
os.dup2(null, sys.stdout.fileno())
2134
2501
2135
2502
parser = argparse.ArgumentParser()
2136
2503
parser.add_argument("-v", "--version", action="version",
2137
version = "%(prog)s {0}".format(version),
2504
version = "%(prog)s {}".format(version),
2138
2505
help="show version number and exit")
2139
2506
parser.add_argument("-i", "--interface", metavar="IF",
2140
2507
help="Bind to interface IF")
2146
2513
help="Run self-test")
2147
2514
parser.add_argument("--debug", action="store_true",
2148
2515
help="Debug mode; run in foreground and log"
2149
" to terminal")
2516
" to terminal", default=None)
2150
2517
parser.add_argument("--debuglevel", metavar="LEVEL",
2151
2518
help="Debug level for stdout output")
2152
2519
parser.add_argument("--priority", help="GnuTLS"
2159
2526
" files")
2160
2527
parser.add_argument("--no-dbus", action="store_false",
2161
2528
dest="use_dbus", help="Do not provide D-Bus"
2162
" system bus interface")
2529
" system bus interface", default=None)
2163
2530
parser.add_argument("--no-ipv6", action="store_false",
2164
dest="use_ipv6", help="Do not use IPv6")
2531
dest="use_ipv6", help="Do not use IPv6",
2532
default=None)
2165
2533
parser.add_argument("--no-restore", action="store_false",
2166
2534
dest="restore", help="Do not restore stored"
2167
" state")
2535
" state", default=None)
2536
parser.add_argument("--socket", type=int,
2537
help="Specify a file descriptor to a network"
2538
" socket to use instead of creating one")
2168
2539
parser.add_argument("--statedir", metavar="DIR",
2169
2540
help="Directory to save/restore state in")
2541
parser.add_argument("--foreground", action="store_true",
2542
help="Run in foreground", default=None)
2543
parser.add_argument("--no-zeroconf", action="store_false",
2544
dest="zeroconf", help="Do not use Zeroconf",
2545
default=None)
2170
2546
2171
2547
options = parser.parse_args()
2172
2548
2173
2549
if options.check:
2174
2550
import doctest
2175
doctest.testmod()
2176
sys.exit()
2551
fail_count, test_count = doctest.testmod()
2552
sys.exit(os.EX_OK if fail_count == 0 else 1)
2177
2553
2178
2554
# Default values for config file for server-global settings
2179
2555
server_defaults = { "interface": "",
2181
2557
"port": "",
2182
2558
"debug": "False",
2183
2559
"priority":
2184
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2560
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2561
":+SIGN-DSA-SHA256",
2185
2562
"servicename": "Mandos",
2186
2563
"use_dbus": "True",
2187
2564
"use_ipv6": "True",
2188
2565
"debuglevel": "",
2189
2566
"restore": "True",
2190
"statedir": "/var/lib/mandos"
2191
}
2567
"socket": "",
2568
"statedir": "/var/lib/mandos",
2569
"foreground": "False",
2570
"zeroconf": "True",
2571
}
2192
2572
2193
2573
# Parse config file for server-global settings
2194
2574
server_config = configparser.SafeConfigParser(server_defaults)
2195
2575
del server_defaults
2196
server_config.read(os.path.join(options.configdir,
2197
"mandos.conf"))
2576
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2198
2577
# Convert the SafeConfigParser object to a dict
2199
2578
server_settings = server_config.defaults()
2200
2579
# Use the appropriate methods on the non-string config options
2201
for option in ("debug", "use_dbus", "use_ipv6"):
2580
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2202
2581
server_settings[option] = server_config.getboolean("DEFAULT",
2203
2582
option)
2204
2583
if server_settings["port"]:
2205
2584
server_settings["port"] = server_config.getint("DEFAULT",
2206
2585
"port")
2586
if server_settings["socket"]:
2587
server_settings["socket"] = server_config.getint("DEFAULT",
2588
"socket")
2589
# Later, stdin will, and stdout and stderr might, be dup'ed
2590
# over with an opened os.devnull. But we don't want this to
2591
# happen with a supplied network socket.
2592
if 0 <= server_settings["socket"] <= 2:
2593
server_settings["socket"] = os.dup(server_settings
2594
["socket"])
2207
2595
del server_config
2208
2596
2209
2597
# Override the settings from the config file with command line
2210
2598
# options, if set.
2211
2599
for option in ("interface", "address", "port", "debug",
2212
"priority", "servicename", "configdir",
2213
"use_dbus", "use_ipv6", "debuglevel", "restore",
2214
"statedir"):
2600
"priority", "servicename", "configdir", "use_dbus",
2601
"use_ipv6", "debuglevel", "restore", "statedir",
2602
"socket", "foreground", "zeroconf"):
2215
2603
value = getattr(options, option)
2216
2604
if value is not None:
2217
2605
server_settings[option] = value
2218
2606
del options
2219
2607
# Force all strings to be unicode
2220
2608
for option in server_settings.keys():
2221
if type(server_settings[option]) is str:
2222
server_settings[option] = unicode(server_settings[option])
2609
if isinstance(server_settings[option], bytes):
2610
server_settings[option] = (server_settings[option]
2611
.decode("utf-8"))
2612
# Force all boolean options to be boolean
2613
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2614
"foreground", "zeroconf"):
2615
server_settings[option] = bool(server_settings[option])
2616
# Debug implies foreground
2617
if server_settings["debug"]:
2618
server_settings["foreground"] = True
2223
2619
# Now we have our good server settings in "server_settings"
2224
2620
2225
2621
##################################################################
2226
2622
2623
if (not server_settings["zeroconf"]
2624
and not (server_settings["port"]
2625
or server_settings["socket"] != "")):
2626
parser.error("Needs port or socket to work without Zeroconf")
2627
2227
2628
# For convenience
2228
2629
debug = server_settings["debug"]
2229
2630
debuglevel = server_settings["debuglevel"]
2231
2632
use_ipv6 = server_settings["use_ipv6"]
2232
2633
stored_state_path = os.path.join(server_settings["statedir"],
2233
2634
stored_state_file)
2635
foreground = server_settings["foreground"]
2636
zeroconf = server_settings["zeroconf"]
2234
2637
2235
2638
if debug:
2236
2639
initlogger(debug, logging.DEBUG)
2242
2645
initlogger(debug, level)
2243
2646
2244
2647
if server_settings["servicename"] != "Mandos":
2245
syslogger.setFormatter(logging.Formatter
2246
('Mandos ({0}) [%(process)d]:'
2247
' %(levelname)s: %(message)s'
2248
.format(server_settings
2249
["servicename"])))
2648
syslogger.setFormatter(
2649
logging.Formatter('Mandos ({}) [%(process)d]:'
2650
' %(levelname)s: %(message)s'.format(
2651
server_settings["servicename"])))
2250
2652
2251
2653
# Parse config file with clients
2252
2654
client_config = configparser.SafeConfigParser(Client
2257
2659
global mandos_dbus_service
2258
2660
mandos_dbus_service = None
2259
2661
2260
tcp_server = MandosServer((server_settings["address"],
2261
server_settings["port"]),
2262
ClientHandler,
2263
interface=(server_settings["interface"]
2264
or None),
2265
use_ipv6=use_ipv6,
2266
gnutls_priority=
2267
server_settings["priority"],
2268
use_dbus=use_dbus)
2269
if not debug:
2270
pidfilename = "/var/run/mandos.pid"
2662
socketfd = None
2663
if server_settings["socket"] != "":
2664
socketfd = server_settings["socket"]
2665
tcp_server = MandosServer(
2666
(server_settings["address"], server_settings["port"]),
2667
ClientHandler,
2668
interface=(server_settings["interface"] or None),
2669
use_ipv6=use_ipv6,
2670
gnutls_priority=server_settings["priority"],
2671
use_dbus=use_dbus,
2672
socketfd=socketfd)
2673
if not foreground:
2674
pidfilename = "/run/mandos.pid"
2675
if not os.path.isdir("/run/."):
2676
pidfilename = "/var/run/mandos.pid"
2677
pidfile = None
2271
2678
try:
2272
pidfile = open(pidfilename, "w")
2679
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2273
2680
except IOError as e:
2274
2681
logger.error("Could not open file %r", pidfilename,
2275
2682
exc_info=e)
2289
2696
os.setuid(uid)
2290
2697
except OSError as error:
2291
2698
if error.errno != errno.EPERM:
2292
raise error
2699
raise
2293
2700
2294
2701
if debug:
2295
2702
# Enable all possible GnuTLS debugging
2302
2709
def debug_gnutls(level, string):
2303
2710
logger.debug("GnuTLS: %s", string[:-1])
2304
2711
2305
(gnutls.library.functions
2306
.gnutls_global_set_log_function(debug_gnutls))
2712
gnutls.library.functions.gnutls_global_set_log_function(
2713
debug_gnutls)
2307
2714
2308
2715
# Redirect stdin so all checkers get /dev/null
2309
2716
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2312
2719
os.close(null)
2313
2720
2314
2721
# Need to fork before connecting to D-Bus
2315
if not debug:
2722
if not foreground:
2316
2723
# Close all input and output, do double fork, etc.
2317
2724
daemon()
2318
2725
2726
# multiprocessing will use threads, so before we use gobject we
2727
# need to inform gobject that threads will be used.
2319
2728
gobject.threads_init()
2320
2729
2321
2730
global main_loop
2327
2736
if use_dbus:
2328
2737
try:
2329
2738
bus_name = dbus.service.BusName("se.recompile.Mandos",
2330
bus, do_not_queue=True)
2331
old_bus_name = (dbus.service.BusName
2332
("se.bsnet.fukt.Mandos", bus,
2333
do_not_queue=True))
2334
except dbus.exceptions.NameExistsException as e:
2739
bus,
2740
do_not_queue=True)
2741
old_bus_name = dbus.service.BusName(
2742
"se.bsnet.fukt.Mandos", bus,
2743
do_not_queue=True)
2744
except dbus.exceptions.DBusException as e:
2335
2745
logger.error("Disabling D-Bus:", exc_info=e)
2336
2746
use_dbus = False
2337
2747
server_settings["use_dbus"] = False
2338
2748
tcp_server.use_dbus = False
2339
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2340
service = AvahiServiceToSyslog(name =
2341
server_settings["servicename"],
2342
servicetype = "_mandos._tcp",
2343
protocol = protocol, bus = bus)
2344
if server_settings["interface"]:
2345
service.interface = (if_nametoindex
2346
(str(server_settings["interface"])))
2749
if zeroconf:
2750
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2751
service = AvahiServiceToSyslog(
2752
name = server_settings["servicename"],
2753
servicetype = "_mandos._tcp",
2754
protocol = protocol,
2755
bus = bus)
2756
if server_settings["interface"]:
2757
service.interface = if_nametoindex(
2758
server_settings["interface"].encode("utf-8"))
2347
2759
2348
2760
global multiprocessing_manager
2349
2761
multiprocessing_manager = multiprocessing.Manager()
2356
2768
old_client_settings = {}
2357
2769
clients_data = {}
2358
2770
2771
# This is used to redirect stdout and stderr for checker processes
2772
global wnull
2773
wnull = open(os.devnull, "w") # A writable /dev/null
2774
# Only used if server is running in foreground but not in debug
2775
# mode
2776
if debug or not foreground:
2777
wnull.close()
2778
2359
2779
# Get client data and settings from last running state.
2360
2780
if server_settings["restore"]:
2361
2781
try:
2362
2782
with open(stored_state_path, "rb") as stored_state:
2363
clients_data, old_client_settings = (pickle.load
2364
(stored_state))
2783
clients_data, old_client_settings = pickle.load(
2784
stored_state)
2365
2785
os.remove(stored_state_path)
2366
2786
except IOError as e:
2367
2787
if e.errno == errno.ENOENT:
2368
logger.warning("Could not load persistent state: {0}"
2369
.format(os.strerror(e.errno)))
2788
logger.warning("Could not load persistent state:"
2789
" {}".format(os.strerror(e.errno)))
2370
2790
else:
2371
2791
logger.critical("Could not load persistent state:",
2372
2792
exc_info=e)
2373
2793
raise
2374
2794
except EOFError as e:
2375
2795
logger.warning("Could not load persistent state: "
2376
"EOFError:", exc_info=e)
2796
"EOFError:",
2797
exc_info=e)
2377
2798
2378
2799
with PGPEngine() as pgp:
2379
for client_name, client in clients_data.iteritems():
2800
for client_name, client in clients_data.items():
2801
# Skip removed clients
2802
if client_name not in client_settings:
2803
continue
2804
2380
2805
# Decide which value to use after restoring saved state.
2381
2806
# We have three different values: Old config file,
2382
2807
# new config file, and saved state.
2387
2812
# For each value in new config, check if it
2388
2813
# differs from the old config value (Except for
2389
2814
# the "secret" attribute)
2390
if (name != "secret" and
2391
value != old_client_settings[client_name]
2392
[name]):
2815
if (name != "secret"
2816
and (value !=
2817
old_client_settings[client_name][name])):
2393
2818
client[name] = value
2394
2819
except KeyError:
2395
2820
pass
2396
2821
2397
2822
# Clients who has passed its expire date can still be
2398
# enabled if its last checker was successful. Clients
2823
# enabled if its last checker was successful. A Client
2399
2824
# whose checker succeeded before we stored its state is
2400
2825
# assumed to have successfully run all checkers during
2401
2826
# downtime.
2403
2828
if datetime.datetime.utcnow() >= client["expires"]:
2404
2829
if not client["last_checked_ok"]:
2405
2830
logger.warning(
2406
"disabling client {0} - Client never "
2407
"performed a successful checker"
2408
.format(client_name))
2831
"disabling client {} - Client never "
2832
"performed a successful checker".format(
2833
client_name))
2409
2834
client["enabled"] = False
2410
2835
elif client["last_checker_status"] != 0:
2411
2836
logger.warning(
2412
"disabling client {0} - Client "
2413
"last checker failed with error code {1}"
2414
.format(client_name,
2415
client["last_checker_status"]))
2837
"disabling client {} - Client last"
2838
" checker failed with error code"
2839
" {}".format(
2840
client_name,
2841
client["last_checker_status"]))
2416
2842
client["enabled"] = False
2417
2843
else:
2418
client["expires"] = (datetime.datetime
2419
.utcnow()
2420
+ client["timeout"])
2844
client["expires"] = (
2845
datetime.datetime.utcnow()
2846
+ client["timeout"])
2421
2847
logger.debug("Last checker succeeded,"
2422
" keeping {0} enabled"
2423
.format(client_name))
2848
" keeping {} enabled".format(
2849
client_name))
2424
2850
try:
2425
client["secret"] = (
2426
pgp.decrypt(client["encrypted_secret"],
2427
client_settings[client_name]
2428
["secret"]))
2851
client["secret"] = pgp.decrypt(
2852
client["encrypted_secret"],
2853
client_settings[client_name]["secret"])
2429
2854
except PGPError:
2430
2855
# If decryption fails, we use secret from new settings
2431
logger.debug("Failed to decrypt {0} old secret"
2432
.format(client_name))
2433
client["secret"] = (
2434
client_settings[client_name]["secret"])
2856
logger.debug("Failed to decrypt {} old secret".format(
2857
client_name))
2858
client["secret"] = (client_settings[client_name]
2859
["secret"])
2435
2860
2436
2861
# Add/remove clients based on new changes made to config
2437
2862
for client_name in (set(old_client_settings)
2442
2867
clients_data[client_name] = client_settings[client_name]
2443
2868
2444
2869
# Create all client objects
2445
for client_name, client in clients_data.iteritems():
2870
for client_name, client in clients_data.items():
2446
2871
tcp_server.clients[client_name] = client_class(
2447
name = client_name, settings = client)
2872
name = client_name,
2873
settings = client,
2874
server_settings = server_settings)
2448
2875
2449
2876
if not tcp_server.clients:
2450
2877
logger.warning("No clients defined")
2451
2878
2452
if not debug:
2453
try:
2454
with pidfile:
2455
pid = os.getpid()
2456
pidfile.write(str(pid) + "\n".encode("utf-8"))
2457
del pidfile
2458
except IOError:
2459
logger.error("Could not write to file %r with PID %d",
2460
pidfilename, pid)
2461
except NameError:
2462
# "pidfile" was never created
2463
pass
2879
if not foreground:
2880
if pidfile is not None:
2881
pid = os.getpid()
2882
try:
2883
with pidfile:
2884
print(pid, file=pidfile)
2885
except IOError:
2886
logger.error("Could not write to file %r with PID %d",
2887
pidfilename, pid)
2888
del pidfile
2464
2889
del pidfilename
2465
2890
2466
2891
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2467
2892
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2468
2893
2469
2894
if use_dbus:
2470
@alternate_dbus_interfaces({"se.recompile.Mandos":
2471
"se.bsnet.fukt.Mandos"})
2472
class MandosDBusService(DBusObjectWithProperties):
2895
2896
@alternate_dbus_interfaces(
2897
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2898
class MandosDBusService(DBusObjectWithObjectManager):
2473
2899
"""A D-Bus proxy object"""
2900
2474
2901
def __init__(self):
2475
2902
dbus.service.Object.__init__(self, bus, "/")
2903
2476
2904
_interface = "se.recompile.Mandos"
2477
2905
2478
@dbus_interface_annotations(_interface)
2479
def _foo(self):
2480
return { "org.freedesktop.DBus.Property"
2481
".EmitsChangedSignal":
2482
"false"}
2483
2484
2906
@dbus.service.signal(_interface, signature="o")
2485
2907
def ClientAdded(self, objpath):
2486
2908
"D-Bus signal"
2491
2913
"D-Bus signal"
2492
2914
pass
2493
2915
2916
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2917
"true"})
2494
2918
@dbus.service.signal(_interface, signature="os")
2495
2919
def ClientRemoved(self, objpath, name):
2496
2920
"D-Bus signal"
2497
2921
pass
2498
2922
2923
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2924
"true"})
2499
2925
@dbus.service.method(_interface, out_signature="ao")
2500
2926
def GetAllClients(self):
2501
2927
"D-Bus method"
2502
return dbus.Array(c.dbus_object_path
2503
for c in
2928
return dbus.Array(c.dbus_object_path for c in
2504
2929
tcp_server.clients.itervalues())
2505
2930
2931
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2932
"true"})
2506
2933
@dbus.service.method(_interface,
2507
2934
out_signature="a{oa{sv}}")
2508
2935
def GetAllClientsWithProperties(self):
2509
2936
"D-Bus method"
2510
2937
return dbus.Dictionary(
2511
((c.dbus_object_path, c.GetAll(""))
2512
for c in tcp_server.clients.itervalues()),
2938
{ c.dbus_object_path: c.GetAll(
2939
"se.recompile.Mandos.Client")
2940
for c in tcp_server.clients.itervalues() },
2513
2941
signature="oa{sv}")
2514
2942
2515
2943
@dbus.service.method(_interface, in_signature="o")
2519
2947
if c.dbus_object_path == object_path:
2520
2948
del tcp_server.clients[c.name]
2521
2949
c.remove_from_connection()
2522
# Don't signal anything except ClientRemoved
2950
# Don't signal the disabling
2523
2951
c.disable(quiet=True)
2524
# Emit D-Bus signal
2525
self.ClientRemoved(object_path, c.name)
2952
# Emit D-Bus signal for removal
2953
self.client_removed_signal(c)
2526
2954
return
2527
2955
raise KeyError(object_path)
2528
2956
2529
2957
del _interface
2958
2959
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
2960
out_signature = "a{oa{sa{sv}}}")
2961
def GetManagedObjects(self):
2962
"""D-Bus method"""
2963
return dbus.Dictionary(
2964
{ client.dbus_object_path:
2965
dbus.Dictionary(
2966
{ interface: client.GetAll(interface)
2967
for interface in
2968
client._get_all_interface_names()})
2969
for client in tcp_server.clients.values()})
2970
2971
def client_added_signal(self, client):
2972
"""Send the new standard signal and the old signal"""
2973
if use_dbus:
2974
# New standard signal
2975
self.InterfacesAdded(
2976
client.dbus_object_path,
2977
dbus.Dictionary(
2978
{ interface: client.GetAll(interface)
2979
for interface in
2980
client._get_all_interface_names()}))
2981
# Old signal
2982
self.ClientAdded(client.dbus_object_path)
2983
2984
def client_removed_signal(self, client):
2985
"""Send the new standard signal and the old signal"""
2986
if use_dbus:
2987
# New standard signal
2988
self.InterfacesRemoved(
2989
client.dbus_object_path,
2990
client._get_all_interface_names())
2991
# Old signal
2992
self.ClientRemoved(client.dbus_object_path,
2993
client.name)
2530
2994
2531
2995
mandos_dbus_service = MandosDBusService()
2532
2996
2533
2997
def cleanup():
2534
2998
"Cleanup function; run on exit"
2535
service.cleanup()
2999
if zeroconf:
3000
service.cleanup()
2536
3001
2537
3002
multiprocessing.active_children()
3003
wnull.close()
2538
3004
if not (tcp_server.clients or client_settings):
2539
3005
return
2540
3006
2551
3017
2552
3018
# A list of attributes that can not be pickled
2553
3019
# + secret.
2554
exclude = set(("bus", "changedstate", "secret",
2555
"checker"))
2556
for name, typ in (inspect.getmembers
2557
(dbus.service.Object)):
3020
exclude = { "bus", "changedstate", "secret",
3021
"checker", "server_settings" }
3022
for name, typ in inspect.getmembers(dbus.service
3023
.Object):
2558
3024
exclude.add(name)
2559
3025
2560
3026
client_dict["encrypted_secret"] = (client
2567
3033
del client_settings[client.name]["secret"]
2568
3034
2569
3035
try:
2570
with (tempfile.NamedTemporaryFile
2571
(mode='wb', suffix=".pickle", prefix='clients-',
2572
dir=os.path.dirname(stored_state_path),
2573
delete=False)) as stored_state:
3036
with tempfile.NamedTemporaryFile(
3037
mode='wb',
3038
suffix=".pickle",
3039
prefix='clients-',
3040
dir=os.path.dirname(stored_state_path),
3041
delete=False) as stored_state:
2574
3042
pickle.dump((clients, client_settings), stored_state)
2575
tempname=stored_state.name
3043
tempname = stored_state.name
2576
3044
os.rename(tempname, stored_state_path)
2577
3045
except (IOError, OSError) as e:
2578
3046
if not debug:
2581
3049
except NameError:
2582
3050
pass
2583
3051
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2584
logger.warning("Could not save persistent state: {0}"
3052
logger.warning("Could not save persistent state: {}"
2585
3053
.format(os.strerror(e.errno)))
2586
3054
else:
2587
3055
logger.warning("Could not save persistent state:",
2588
3056
exc_info=e)
2589
raise e
3057
raise
2590
3058
2591
3059
# Delete all clients, and settings from config
2592
3060
while tcp_server.clients:
2593
3061
name, client = tcp_server.clients.popitem()
2594
3062
if use_dbus:
2595
3063
client.remove_from_connection()
2596
# Don't signal anything except ClientRemoved
3064
# Don't signal the disabling
2597
3065
client.disable(quiet=True)
2598
if use_dbus:
2599
# Emit D-Bus signal
2600
mandos_dbus_service.ClientRemoved(client
2601
.dbus_object_path,
2602
client.name)
3066
# Emit D-Bus signal for removal
3067
mandos_dbus_service.client_removed_signal(client)
2603
3068
client_settings.clear()
2604
3069
2605
3070
atexit.register(cleanup)
2606
3071
2607
3072
for client in tcp_server.clients.itervalues():
2608
3073
if use_dbus:
2609
# Emit D-Bus signal
2610
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3074
# Emit D-Bus signal for adding
3075
mandos_dbus_service.client_added_signal(client)
2611
3076
# Need to initiate checking of clients
2612
3077
if client.enabled:
2613
3078
client.init_checker()
2616
3081
tcp_server.server_activate()
2617
3082
2618
3083
# Find out what port we got
2619
service.port = tcp_server.socket.getsockname()[1]
3084
if zeroconf:
3085
service.port = tcp_server.socket.getsockname()[1]
2620
3086
if use_ipv6:
2621
3087
logger.info("Now listening on address %r, port %d,"
2622
3088
" flowinfo %d, scope_id %d",
2628
3094
#service.interface = tcp_server.socket.getsockname()[3]
2629
3095
2630
3096
try:
2631
# From the Avahi example code
2632
try:
2633
service.activate()
2634
except dbus.exceptions.DBusException as error:
2635
logger.critical("D-Bus Exception", exc_info=error)
2636
cleanup()
2637
sys.exit(1)
2638
# End of Avahi example code
3097
if zeroconf:
3098
# From the Avahi example code
3099
try:
3100
service.activate()
3101
except dbus.exceptions.DBusException as error:
3102
logger.critical("D-Bus Exception", exc_info=error)
3103
cleanup()
3104
sys.exit(1)
3105
# End of Avahi example code
2639
3106
2640
3107
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2641
3108
lambda *args, **kwargs:
2656
3123
# Must run before the D-Bus bus name gets deregistered
2657
3124
cleanup()
2658
3125
3126
2659
3127
if __name__ == '__main__':
2660
3128
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0