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