2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos server - give out binary blobs to connecting clients.
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
13
13
# Everything else is
14
# Copyright © 2008-2017 Teddy Hogeborn
15
# Copyright © 2008-2017 Björn Påhlsson
17
# This file is part of Mandos.
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27
25
# GNU General Public License for more details.
29
27
# You should have received a copy of the GNU General Public License
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
32
31
# Contact the authors at <mandos@recompile.se>.
35
34
from __future__ import (division, absolute_import, print_function,
39
from future_builtins import *
37
from future_builtins import *
44
import SocketServer as socketserver
39
import SocketServer as socketserver
52
import ConfigParser as configparser
45
import gnutls.connection
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
70
import cPickle as pickle
65
import cPickle as pickle
73
66
import multiprocessing
82
73
import dbus.service
83
from gi.repository import GLib
84
76
from dbus.mainloop.glib import DBusGMainLoop
87
79
import xml.dom.minidom
90
# Try to find the value of SO_BINDTODEVICE:
92
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
93
# newer, and it is also the most natural place for it:
94
84
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
95
85
except AttributeError:
97
# This is where SO_BINDTODEVICE was up to and including Python
99
87
from IN import SO_BINDTODEVICE
100
88
except ImportError:
101
# In Python 2.7 it seems to have been removed entirely.
102
# Try running the C preprocessor:
104
cc = subprocess.Popen(["cc", "--language=c", "-E",
106
stdin=subprocess.PIPE,
107
stdout=subprocess.PIPE)
108
stdout = cc.communicate(
109
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
110
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
111
except (OSError, ValueError, IndexError):
113
SO_BINDTODEVICE = None
115
if sys.version_info.major == 2:
89
SO_BINDTODEVICE = None
119
92
stored_state_file = "clients.pickle"
121
94
logger = logging.getLogger()
95
syslogger = (logging.handlers.SysLogHandler
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
address = str("/dev/log")))
125
if_nametoindex = ctypes.cdll.LoadLibrary(
126
ctypes.util.find_library("c")).if_nametoindex
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
127
103
except (OSError, AttributeError):
129
104
def if_nametoindex(interface):
130
105
"Get an interface index the hard way, i.e. using fcntl()"
131
106
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
132
107
with contextlib.closing(socket.socket()) as s:
133
108
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
134
struct.pack(b"16s16x", interface))
135
interface_index = struct.unpack("I", ifreq[16:20])[0]
109
struct.pack(str("16s16x"),
111
interface_index = struct.unpack(str("I"),
136
113
return interface_index
139
def copy_function(func):
140
"""Make a copy of a function"""
141
if sys.version_info.major == 2:
142
return types.FunctionType(func.func_code,
148
return types.FunctionType(func.__code__,
155
116
def initlogger(debug, level=logging.WARNING):
156
117
"""init logger and add loglevel"""
159
syslogger = (logging.handlers.SysLogHandler(
160
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
162
119
syslogger.setFormatter(logging.Formatter
163
120
('Mandos [%(process)d]: %(levelname)s:'
165
122
logger.addHandler(syslogger)
168
125
console = logging.StreamHandler()
169
126
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
226
171
os.rmdir(self.tempdir)
227
172
self.tempdir = None
229
174
def password_encode(self, password):
230
175
# Passphrase can not be empty and can not contain newlines or
231
176
# NUL bytes. So we prefix it and hex encode it.
232
encoded = b"mandos" + binascii.hexlify(password)
233
if len(encoded) > 2048:
234
# GnuPG can't handle long passwords, so encode differently
235
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
236
.replace(b"\n", b"\\n")
237
.replace(b"\0", b"\\x00"))
177
return b"mandos" + binascii.hexlify(password)
240
179
def encrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
254
if proc.returncode != 0:
180
self.gnupg.passphrase = self.password_encode(password)
181
with open(os.devnull, "w") as devnull:
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:
188
with contextlib.closing(proc.handles['stdout']) as f:
189
ciphertext = f.read()
193
self.gnupg.passphrase = None
256
194
return ciphertext
258
196
def decrypt(self, data, password):
259
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
262
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
272
if proc.returncode != 0:
197
self.gnupg.passphrase = self.password_encode(password)
198
with open(os.devnull, "w") as devnull:
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:
205
with contextlib.closing(proc.handles['stdout']) as f:
206
decrypted_plaintext = f.read()
210
self.gnupg.passphrase = None
274
211
return decrypted_plaintext
277
# Pretend that we have an Avahi module
279
"""This isn't so much a class as it is a module-like namespace.
280
It is instantiated once, and simulates having an Avahi module."""
281
IF_UNSPEC = -1 # avahi-common/address.h
282
PROTO_UNSPEC = -1 # avahi-common/address.h
283
PROTO_INET = 0 # avahi-common/address.h
284
PROTO_INET6 = 1 # avahi-common/address.h
285
DBUS_NAME = "org.freedesktop.Avahi"
286
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
287
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
288
DBUS_PATH_SERVER = "/"
290
def string_array_to_txt_array(self, t):
291
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
for s in t), signature="ay")
293
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
294
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
295
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
296
SERVER_INVALID = 0 # avahi-common/defs.h
297
SERVER_REGISTERING = 1 # avahi-common/defs.h
298
SERVER_RUNNING = 2 # avahi-common/defs.h
299
SERVER_COLLISION = 3 # avahi-common/defs.h
300
SERVER_FAILURE = 4 # avahi-common/defs.h
304
214
class AvahiError(Exception):
305
215
def __init__(self, value, *args, **kwargs):
306
216
self.value = value
307
return super(AvahiError, self).__init__(value, *args,
217
super(AvahiError, self).__init__(value, *args, **kwargs)
218
def __unicode__(self):
219
return unicode(repr(self.value))
311
221
class AvahiServiceError(AvahiError):
315
224
class AvahiGroupError(AvahiError):
319
228
class AvahiService(object):
320
229
"""An Avahi (Zeroconf) service.
323
232
interface: integer; avahi.IF_UNSPEC or an interface index.
324
233
Used to optionally bind to the specified interface.
325
234
name: string; Example: 'Mandos'
326
235
type: string; Example: '_mandos._tcp'.
327
See <https://www.iana.org/assignments/service-names-port-numbers>
236
See <http://www.dns-sd.org/ServiceTypes.html>
328
237
port: integer; what port to announce
329
238
TXT: list of strings; TXT record for the service
330
239
domain: string; Domain to publish on, default to .local if empty.
489
376
follow_name_owner_changes=True),
490
377
avahi.DBUS_INTERFACE_SERVER)
491
378
self.server.connect_to_signal("StateChanged",
492
self.server_state_changed)
379
self.server_state_changed)
493
380
self.server_state_changed(self.server.GetState())
496
382
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
498
384
"""Add the new name to the syslog messages"""
499
ret = AvahiService.rename(self, *args, **kwargs)
500
syslogger.setFormatter(logging.Formatter(
501
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
385
ret = AvahiService.rename(self)
386
syslogger.setFormatter(logging.Formatter
387
('Mandos ({0}) [%(process)d]:'
388
' %(levelname)s: %(message)s'
506
# Pretend that we have a GnuTLS module
507
class GnuTLS(object):
508
"""This isn't so much a class as it is a module-like namespace.
509
It is instantiated once, and simulates having a GnuTLS module."""
511
library = ctypes.util.find_library("gnutls")
513
library = ctypes.util.find_library("gnutls-deb0")
514
_library = ctypes.cdll.LoadLibrary(library)
516
_need_version = b"3.3.0"
519
# Need to use "self" here, since this method is called before
520
# the assignment to the "gnutls" global variable happens.
521
if self.check_version(self._need_version) is None:
522
raise self.Error("Needs GnuTLS {} or later"
523
.format(self._need_version))
525
# Unless otherwise indicated, the constants and types below are
526
# all from the gnutls/gnutls.h C header file.
536
E_NO_CERTIFICATE_FOUND = -49
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
# We need to use the class name "GnuTLS" here, since this
566
# exception might be raised from within GnuTLS.__init__,
567
# which is called before the assignment to the "gnutls"
568
# global variable has happened.
569
def __init__(self, message=None, code=None, args=()):
570
# Default usage is by a message string, but if a return
571
# code is passed, convert it to a string with
574
if message is None and code is not None:
575
message = GnuTLS.strerror(code)
576
return super(GnuTLS.Error, self).__init__(
579
class CertificateSecurityError(Error):
583
class Credentials(object):
585
self._c_object = gnutls.certificate_credentials_t()
586
gnutls.certificate_allocate_credentials(
587
ctypes.byref(self._c_object))
588
self.type = gnutls.CRD_CERTIFICATE
591
gnutls.certificate_free_credentials(self._c_object)
593
class ClientSession(object):
594
def __init__(self, socket, credentials=None):
595
self._c_object = gnutls.session_t()
596
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
597
gnutls.set_default_priority(self._c_object)
598
gnutls.transport_set_ptr(self._c_object, socket.fileno())
599
gnutls.handshake_set_private_extensions(self._c_object,
602
if credentials is None:
603
credentials = gnutls.Credentials()
604
gnutls.credentials_set(self._c_object, credentials.type,
605
ctypes.cast(credentials._c_object,
607
self.credentials = credentials
610
gnutls.deinit(self._c_object)
613
return gnutls.handshake(self._c_object)
615
def send(self, data):
619
data_len -= gnutls.record_send(self._c_object,
624
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
626
# Error handling functions
627
def _error_code(result):
628
"""A function to raise exceptions on errors, suitable
629
for the 'restype' attribute on ctypes functions"""
632
if result == gnutls.E_NO_CERTIFICATE_FOUND:
633
raise gnutls.CertificateSecurityError(code=result)
634
raise gnutls.Error(code=result)
636
def _retry_on_error(result, func, arguments):
637
"""A function to retry on some errors, suitable
638
for the 'errcheck' attribute on ctypes functions"""
640
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
641
return _error_code(result)
642
result = func(*arguments)
645
# Unless otherwise indicated, the function declarations below are
646
# all from the gnutls/gnutls.h C header file.
649
priority_set_direct = _library.gnutls_priority_set_direct
650
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
651
ctypes.POINTER(ctypes.c_char_p)]
652
priority_set_direct.restype = _error_code
654
init = _library.gnutls_init
655
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
656
init.restype = _error_code
658
set_default_priority = _library.gnutls_set_default_priority
659
set_default_priority.argtypes = [session_t]
660
set_default_priority.restype = _error_code
662
record_send = _library.gnutls_record_send
663
record_send.argtypes = [session_t, ctypes.c_void_p,
665
record_send.restype = ctypes.c_ssize_t
666
record_send.errcheck = _retry_on_error
668
certificate_allocate_credentials = (
669
_library.gnutls_certificate_allocate_credentials)
670
certificate_allocate_credentials.argtypes = [
671
ctypes.POINTER(certificate_credentials_t)]
672
certificate_allocate_credentials.restype = _error_code
674
certificate_free_credentials = (
675
_library.gnutls_certificate_free_credentials)
676
certificate_free_credentials.argtypes = [
677
certificate_credentials_t]
678
certificate_free_credentials.restype = None
680
handshake_set_private_extensions = (
681
_library.gnutls_handshake_set_private_extensions)
682
handshake_set_private_extensions.argtypes = [session_t,
684
handshake_set_private_extensions.restype = None
686
credentials_set = _library.gnutls_credentials_set
687
credentials_set.argtypes = [session_t, credentials_type_t,
689
credentials_set.restype = _error_code
691
strerror = _library.gnutls_strerror
692
strerror.argtypes = [ctypes.c_int]
693
strerror.restype = ctypes.c_char_p
695
certificate_type_get = _library.gnutls_certificate_type_get
696
certificate_type_get.argtypes = [session_t]
697
certificate_type_get.restype = _error_code
699
certificate_get_peers = _library.gnutls_certificate_get_peers
700
certificate_get_peers.argtypes = [session_t,
701
ctypes.POINTER(ctypes.c_uint)]
702
certificate_get_peers.restype = ctypes.POINTER(datum_t)
704
global_set_log_level = _library.gnutls_global_set_log_level
705
global_set_log_level.argtypes = [ctypes.c_int]
706
global_set_log_level.restype = None
708
global_set_log_function = _library.gnutls_global_set_log_function
709
global_set_log_function.argtypes = [log_func]
710
global_set_log_function.restype = None
712
deinit = _library.gnutls_deinit
713
deinit.argtypes = [session_t]
714
deinit.restype = None
716
handshake = _library.gnutls_handshake
717
handshake.argtypes = [session_t]
718
handshake.restype = _error_code
719
handshake.errcheck = _retry_on_error
721
transport_set_ptr = _library.gnutls_transport_set_ptr
722
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
723
transport_set_ptr.restype = None
725
bye = _library.gnutls_bye
726
bye.argtypes = [session_t, close_request_t]
727
bye.restype = _error_code
728
bye.errcheck = _retry_on_error
730
check_version = _library.gnutls_check_version
731
check_version.argtypes = [ctypes.c_char_p]
732
check_version.restype = ctypes.c_char_p
734
# All the function declarations below are from gnutls/openpgp.h
736
openpgp_crt_init = _library.gnutls_openpgp_crt_init
737
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
738
openpgp_crt_init.restype = _error_code
740
openpgp_crt_import = _library.gnutls_openpgp_crt_import
741
openpgp_crt_import.argtypes = [openpgp_crt_t,
742
ctypes.POINTER(datum_t),
744
openpgp_crt_import.restype = _error_code
746
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
747
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
748
ctypes.POINTER(ctypes.c_uint)]
749
openpgp_crt_verify_self.restype = _error_code
751
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
752
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
753
openpgp_crt_deinit.restype = None
755
openpgp_crt_get_fingerprint = (
756
_library.gnutls_openpgp_crt_get_fingerprint)
757
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
761
openpgp_crt_get_fingerprint.restype = _error_code
763
# Remove non-public functions
764
del _error_code, _retry_on_error
765
# Create the global "gnutls" object, simulating a module
769
def call_pipe(connection, # : multiprocessing.Connection
770
func, *args, **kwargs):
771
"""This function is meant to be called by multiprocessing.Process
773
This function runs func(*args, **kwargs), and writes the resulting
774
return value on the provided multiprocessing.Connection.
776
connection.send(func(*args, **kwargs))
392
def timedelta_to_milliseconds(td):
393
"Convert a datetime.timedelta() to milliseconds"
394
return ((td.days * 24 * 60 * 60 * 1000)
395
+ (td.seconds * 1000)
396
+ (td.microseconds // 1000))
780
398
class Client(object):
781
399
"""A representation of a client host served by this server.
784
402
approved: bool(); 'None' if not yet approved/disapproved
785
403
approval_delay: datetime.timedelta(); Time to wait for approval
820
436
runtime_expansions: Allowed attributes for runtime expansion.
821
437
expires: datetime.datetime(); time (UTC) when a client will be
822
438
disabled, or None
823
server_settings: The server_settings dict from main()
826
441
runtime_expansions = ("approval_delay", "approval_duration",
827
"created", "enabled", "expires",
828
"fingerprint", "host", "interval",
829
"last_approval_request", "last_checked_ok",
442
"created", "enabled", "fingerprint",
443
"host", "interval", "last_checked_ok",
830
444
"last_enabled", "name", "timeout")
833
"extended_timeout": "PT15M",
835
"checker": "fping -q -- %%(host)s",
837
"approval_delay": "PT0S",
838
"approval_duration": "PT1S",
839
"approved_by_default": "True",
445
client_defaults = { "timeout": "5m",
446
"extended_timeout": "15m",
448
"checker": "fping -q -- %%(host)s",
450
"approval_delay": "0s",
451
"approval_duration": "1s",
452
"approved_by_default": "True",
456
def timeout_milliseconds(self):
457
"Return the 'timeout' attribute in milliseconds"
458
return timedelta_to_milliseconds(self.timeout)
460
def extended_timeout_milliseconds(self):
461
"Return the 'extended_timeout' attribute in milliseconds"
462
return timedelta_to_milliseconds(self.extended_timeout)
464
def interval_milliseconds(self):
465
"Return the 'interval' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.interval)
468
def approval_delay_milliseconds(self):
469
return timedelta_to_milliseconds(self.approval_delay)
844
472
def config_parser(config):
845
473
"""Construct a new dict of client settings of this form:
924
547
self.current_checker_command = None
925
548
self.approved = None
926
549
self.approvals_pending = 0
927
self.changedstate = multiprocessing_manager.Condition(
928
multiprocessing_manager.Lock())
929
self.client_structure = [attr
930
for attr in self.__dict__.keys()
550
self.changedstate = (multiprocessing_manager
551
.Condition(multiprocessing_manager
553
self.client_structure = [attr for attr in
554
self.__dict__.iterkeys()
931
555
if not attr.startswith("_")]
932
556
self.client_structure.append("client_structure")
934
for name, t in inspect.getmembers(
935
type(self), lambda obj: isinstance(obj, property)):
558
for name, t in inspect.getmembers(type(self),
936
562
if not name.startswith("_"):
937
563
self.client_structure.append(name)
939
565
# Send notice to process children that client state has changed
940
566
def send_changedstate(self):
941
567
with self.changedstate:
942
568
self.changedstate.notify_all()
944
570
def enable(self):
945
571
"""Start this client's checker and timeout hooks"""
946
572
if getattr(self, "enabled", False):
947
573
# Already enabled
575
self.send_changedstate()
949
576
self.expires = datetime.datetime.utcnow() + self.timeout
950
577
self.enabled = True
951
578
self.last_enabled = datetime.datetime.utcnow()
952
579
self.init_checker()
953
self.send_changedstate()
955
581
def disable(self, quiet=True):
956
582
"""Disable this client."""
957
583
if not getattr(self, "enabled", False):
586
self.send_changedstate()
960
588
logger.info("Disabling client %s", self.name)
961
if getattr(self, "disable_initiator_tag", None) is not None:
962
GLib.source_remove(self.disable_initiator_tag)
589
if getattr(self, "disable_initiator_tag", False):
590
gobject.source_remove(self.disable_initiator_tag)
963
591
self.disable_initiator_tag = None
964
592
self.expires = None
965
if getattr(self, "checker_initiator_tag", None) is not None:
966
GLib.source_remove(self.checker_initiator_tag)
593
if getattr(self, "checker_initiator_tag", False):
594
gobject.source_remove(self.checker_initiator_tag)
967
595
self.checker_initiator_tag = None
968
596
self.stop_checker()
969
597
self.enabled = False
971
self.send_changedstate()
972
# Do not run this again if called by a GLib.timeout_add
598
# Do not run this again if called by a gobject.timeout_add
975
601
def __del__(self):
978
604
def init_checker(self):
979
605
# Schedule a new checker to be started an 'interval' from now,
980
606
# and every interval from then on.
981
if self.checker_initiator_tag is not None:
982
GLib.source_remove(self.checker_initiator_tag)
983
self.checker_initiator_tag = GLib.timeout_add(
984
int(self.interval.total_seconds() * 1000),
607
self.checker_initiator_tag = (gobject.timeout_add
608
(self.interval_milliseconds(),
986
610
# Schedule a disable() when 'timeout' has passed
987
if self.disable_initiator_tag is not None:
988
GLib.source_remove(self.disable_initiator_tag)
989
self.disable_initiator_tag = GLib.timeout_add(
990
int(self.timeout.total_seconds() * 1000), self.disable)
611
self.disable_initiator_tag = (gobject.timeout_add
612
(self.timeout_milliseconds(),
991
614
# Also start a new checker *right now*.
992
615
self.start_checker()
994
def checker_callback(self, source, condition, connection,
617
def checker_callback(self, pid, condition, command):
996
618
"""The checker has completed, so take appropriate actions."""
997
619
self.checker_callback_tag = None
998
620
self.checker = None
999
# Read return code from connection (see call_pipe)
1000
returncode = connection.recv()
1004
self.last_checker_status = returncode
1005
self.last_checker_signal = None
621
if os.WIFEXITED(condition):
622
self.last_checker_status = os.WEXITSTATUS(condition)
1006
623
if self.last_checker_status == 0:
1007
624
logger.info("Checker for %(name)s succeeded",
1009
626
self.checked_ok()
1011
logger.info("Checker for %(name)s failed", vars(self))
628
logger.info("Checker for %(name)s failed",
1013
631
self.last_checker_status = -1
1014
self.last_checker_signal = -returncode
1015
632
logger.warning("Checker for %(name)s crashed?",
1019
635
def checked_ok(self):
1020
636
"""Assert that the client has been seen, alive and well."""
1021
637
self.last_checked_ok = datetime.datetime.utcnow()
1022
638
self.last_checker_status = 0
1023
self.last_checker_signal = None
1024
639
self.bump_timeout()
1026
641
def bump_timeout(self, timeout=None):
1027
642
"""Bump up the timeout for this client."""
1028
643
if timeout is None:
1029
644
timeout = self.timeout
1030
645
if self.disable_initiator_tag is not None:
1031
GLib.source_remove(self.disable_initiator_tag)
1032
self.disable_initiator_tag = None
646
gobject.source_remove(self.disable_initiator_tag)
1033
647
if getattr(self, "enabled", False):
1034
self.disable_initiator_tag = GLib.timeout_add(
1035
int(timeout.total_seconds() * 1000), self.disable)
648
self.disable_initiator_tag = (gobject.timeout_add
649
(timedelta_to_milliseconds
650
(timeout), self.disable))
1036
651
self.expires = datetime.datetime.utcnow() + timeout
1038
653
def need_approval(self):
1039
654
self.last_approval_request = datetime.datetime.utcnow()
1041
656
def start_checker(self):
1042
657
"""Start a new checker subprocess if one is not running.
1044
659
If a checker already exists, leave it running and do
1046
661
# The reason for not killing a running checker is that if we
1051
666
# checkers alone, the checker would have to take more time
1052
667
# than 'timeout' for the client to be disabled, which is as it
1055
if self.checker is not None and not self.checker.is_alive():
1056
logger.warning("Checker was not alive; joining")
670
# If a checker exists, make sure it is not a zombie
672
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
673
except (AttributeError, OSError) as error:
674
if (isinstance(error, OSError)
675
and error.errno != errno.ECHILD):
679
logger.warning("Checker was a zombie")
680
gobject.source_remove(self.checker_callback_tag)
681
self.checker_callback(pid, status,
682
self.current_checker_command)
1059
683
# Start a new checker if needed
1060
684
if self.checker is None:
1061
# Escape attributes for the shell
1063
attr: re.escape(str(getattr(self, attr)))
1064
for attr in self.runtime_expansions}
1066
command = self.checker_command % escaped_attrs
1067
except TypeError as error:
1068
logger.error('Could not format string "%s"',
1069
self.checker_command,
686
# In case checker_command has exactly one % operator
687
command = self.checker_command % self.host
689
# Escape attributes for the shell
690
escaped_attrs = dict(
692
re.escape(unicode(str(getattr(self, attr, "")),
696
self.runtime_expansions)
699
command = self.checker_command % escaped_attrs
700
except TypeError as error:
701
logger.error('Could not format string "%s"',
702
self.checker_command, exc_info=error)
703
return True # Try again later
704
self.current_checker_command = command
706
logger.info("Starting checker %r for %s",
708
# We don't need to redirect stdout and stderr, since
709
# in normal mode, that is already done by daemon(),
710
# and in debug mode we don't want to. (Stdin is
711
# always replaced by /dev/null.)
712
self.checker = subprocess.Popen(command,
715
self.checker_callback_tag = (gobject.child_watch_add
717
self.checker_callback,
719
# The checker may have completed before the gobject
720
# watch was added. Check for this.
721
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
723
gobject.source_remove(self.checker_callback_tag)
724
self.checker_callback(pid, status, command)
725
except OSError as error:
726
logger.error("Failed to start subprocess",
1071
return True # Try again later
1072
self.current_checker_command = command
1073
logger.info("Starting checker %r for %s", command,
1075
# We don't need to redirect stdout and stderr, since
1076
# in normal mode, that is already done by daemon(),
1077
# and in debug mode we don't want to. (Stdin is
1078
# always replaced by /dev/null.)
1079
# The exception is when not debugging but nevertheless
1080
# running in the foreground; use the previously
1082
popen_args = {"close_fds": True,
1085
if (not self.server_settings["debug"]
1086
and self.server_settings["foreground"]):
1087
popen_args.update({"stdout": wnull,
1089
pipe = multiprocessing.Pipe(duplex=False)
1090
self.checker = multiprocessing.Process(
1092
args=(pipe[1], subprocess.call, command),
1094
self.checker.start()
1095
self.checker_callback_tag = GLib.io_add_watch(
1096
pipe[0].fileno(), GLib.IO_IN,
1097
self.checker_callback, pipe[0], command)
1098
# Re-run this periodically if run by GLib.timeout_add
728
# Re-run this periodically if run by gobject.timeout_add
1101
731
def stop_checker(self):
1102
732
"""Force the checker process, if any, to stop."""
1103
733
if self.checker_callback_tag:
1104
GLib.source_remove(self.checker_callback_tag)
734
gobject.source_remove(self.checker_callback_tag)
1105
735
self.checker_callback_tag = None
1106
736
if getattr(self, "checker", None) is None:
1108
738
logger.debug("Stopping checker for %(name)s", vars(self))
1109
self.checker.terminate()
740
self.checker.terminate()
742
#if self.checker.poll() is None:
743
# self.checker.kill()
744
except OSError as error:
745
if error.errno != errno.ESRCH: # No such process
1110
747
self.checker = None
1113
def dbus_service_property(dbus_interface,
750
def dbus_service_property(dbus_interface, signature="v",
751
access="readwrite", byte_arrays=False):
1117
752
"""Decorators for marking methods of a DBusObjectWithProperties to
1118
753
become properties on the D-Bus.
1120
755
The decorated method will be called with no arguments by "Get"
1121
756
and with one argument by "Set".
1123
758
The parameters, where they are supported, are the same as
1124
759
dbus.service.method, except there is only "signature", since the
1125
760
type from Get() and the type sent to Set() is the same.
1208
class DBusObjectWithAnnotations(dbus.service.Object):
1209
"""A D-Bus object with annotations.
1211
Classes inheriting from this can use the dbus_annotations
1212
decorator to add annotations to methods or signals.
836
class DBusObjectWithProperties(dbus.service.Object):
837
"""A D-Bus object with properties.
839
Classes inheriting from this can use the dbus_service_property
840
decorator to expose methods as D-Bus properties. It exposes the
841
standard Get(), Set(), and GetAll() methods on the D-Bus.
1216
845
def _is_dbus_thing(thing):
1217
846
"""Returns a function testing if an attribute is a D-Bus thing
1219
848
If called like _is_dbus_thing("method") it returns a function
1220
849
suitable for use as predicate to inspect.getmembers().
1222
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
851
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1225
854
def _get_all_dbus_things(self, thing):
1226
855
"""Returns a generator of (name, attribute) pairs
1228
return ((getattr(athing.__get__(self), "_dbus_name", name),
857
return ((getattr(athing.__get__(self), "_dbus_name",
1229
859
athing.__get__(self))
1230
860
for cls in self.__class__.__mro__
1231
861
for name, athing in
1232
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1234
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1236
path_keyword='object_path',
1237
connection_keyword='connection')
1238
def Introspect(self, object_path, connection):
1239
"""Overloading of standard D-Bus method.
1241
Inserts annotation tags on methods and signals.
1243
xmlstring = dbus.service.Object.Introspect(self, object_path,
1246
document = xml.dom.minidom.parseString(xmlstring)
1248
for if_tag in document.getElementsByTagName("interface"):
1249
# Add annotation tags
1250
for typ in ("method", "signal"):
1251
for tag in if_tag.getElementsByTagName(typ):
1253
for name, prop in (self.
1254
_get_all_dbus_things(typ)):
1255
if (name == tag.getAttribute("name")
1256
and prop._dbus_interface
1257
== if_tag.getAttribute("name")):
1258
annots.update(getattr(
1259
prop, "_dbus_annotations", {}))
1260
for name, value in annots.items():
1261
ann_tag = document.createElement(
1263
ann_tag.setAttribute("name", name)
1264
ann_tag.setAttribute("value", value)
1265
tag.appendChild(ann_tag)
1266
# Add interface annotation tags
1267
for annotation, value in dict(
1268
itertools.chain.from_iterable(
1269
annotations().items()
1270
for name, annotations
1271
in self._get_all_dbus_things("interface")
1272
if name == if_tag.getAttribute("name")
1274
ann_tag = document.createElement("annotation")
1275
ann_tag.setAttribute("name", annotation)
1276
ann_tag.setAttribute("value", value)
1277
if_tag.appendChild(ann_tag)
1278
# Fix argument name for the Introspect method itself
1279
if (if_tag.getAttribute("name")
1280
== dbus.INTROSPECTABLE_IFACE):
1281
for cn in if_tag.getElementsByTagName("method"):
1282
if cn.getAttribute("name") == "Introspect":
1283
for arg in cn.getElementsByTagName("arg"):
1284
if (arg.getAttribute("direction")
1286
arg.setAttribute("name",
1288
xmlstring = document.toxml("utf-8")
1290
except (AttributeError, xml.dom.DOMException,
1291
xml.parsers.expat.ExpatError) as error:
1292
logger.error("Failed to override Introspection method",
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1298
"""A D-Bus object with properties.
1300
Classes inheriting from this can use the dbus_service_property
1301
decorator to expose methods as D-Bus properties. It exposes the
1302
standard Get(), Set(), and GetAll() methods on the D-Bus.
862
inspect.getmembers(cls,
863
self._is_dbus_thing(thing)))
1305
865
def _get_dbus_property(self, interface_name, property_name):
1306
866
"""Returns a bound method if one exists which is a D-Bus
1307
867
property with the specified name and interface.
1309
for cls in self.__class__.__mro__:
1310
for name, value in inspect.getmembers(
1311
cls, self._is_dbus_thing("property")):
869
for cls in self.__class__.__mro__:
870
for name, value in (inspect.getmembers
872
self._is_dbus_thing("property"))):
1312
873
if (value._dbus_name == property_name
1313
874
and value._dbus_interface == interface_name):
1314
875
return value.__get__(self)
1316
877
# No such property
1317
raise DBusPropertyNotFound("{}:{}.{}".format(
1318
self.dbus_object_path, interface_name, property_name))
1321
def _get_all_interface_names(cls):
1322
"""Get a sequence of all interfaces supported by an object"""
1323
return (name for name in set(getattr(getattr(x, attr),
1324
"_dbus_interface", None)
1325
for x in (inspect.getmro(cls))
1327
if name is not None)
1329
@dbus.service.method(dbus.PROPERTIES_IFACE,
878
raise DBusPropertyNotFound(self.dbus_object_path + ":"
879
+ interface_name + "."
882
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1331
883
out_signature="v")
1332
884
def Get(self, interface_name, property_name):
1333
885
"""Standard D-Bus property Get() method, see D-Bus standard.
1462
1015
return xmlstring
1466
dbus.OBJECT_MANAGER_IFACE
1467
except AttributeError:
1468
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1471
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1472
"""A D-Bus object with an ObjectManager.
1474
Classes inheriting from this exposes the standard
1475
GetManagedObjects call and the InterfacesAdded and
1476
InterfacesRemoved signals on the standard
1477
"org.freedesktop.DBus.ObjectManager" interface.
1479
Note: No signals are sent automatically; they must be sent
1482
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1483
out_signature="a{oa{sa{sv}}}")
1484
def GetManagedObjects(self):
1485
"""This function must be overridden"""
1486
raise NotImplementedError()
1488
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1489
signature="oa{sa{sv}}")
1490
def InterfacesAdded(self, object_path, interfaces_and_properties):
1493
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1494
def InterfacesRemoved(self, object_path, interfaces):
1497
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1499
path_keyword='object_path',
1500
connection_keyword='connection')
1501
def Introspect(self, object_path, connection):
1502
"""Overloading of standard D-Bus method.
1504
Override return argument name of GetManagedObjects to be
1505
"objpath_interfaces_and_properties"
1507
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1511
document = xml.dom.minidom.parseString(xmlstring)
1513
for if_tag in document.getElementsByTagName("interface"):
1514
# Fix argument name for the GetManagedObjects method
1515
if (if_tag.getAttribute("name")
1516
== dbus.OBJECT_MANAGER_IFACE):
1517
for cn in if_tag.getElementsByTagName("method"):
1518
if (cn.getAttribute("name")
1519
== "GetManagedObjects"):
1520
for arg in cn.getElementsByTagName("arg"):
1521
if (arg.getAttribute("direction")
1525
"objpath_interfaces"
1527
xmlstring = document.toxml("utf-8")
1529
except (AttributeError, xml.dom.DOMException,
1530
xml.parsers.expat.ExpatError) as error:
1531
logger.error("Failed to override Introspection method",
1536
def datetime_to_dbus(dt, variant_level=0):
1018
def datetime_to_dbus (dt, variant_level=0):
1537
1019
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1539
return dbus.String("", variant_level=variant_level)
1540
return dbus.String(dt.isoformat(), variant_level=variant_level)
1021
return dbus.String("", variant_level = variant_level)
1022
return dbus.String(dt.isoformat(),
1023
variant_level=variant_level)
1543
1026
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1574
1056
# Ignore non-D-Bus attributes, and D-Bus attributes
1575
1057
# with the wrong interface name
1576
1058
if (not hasattr(attribute, "_dbus_interface")
1577
or not attribute._dbus_interface.startswith(
1578
orig_interface_name)):
1059
or not attribute._dbus_interface
1060
.startswith(orig_interface_name)):
1580
1062
# Create an alternate D-Bus interface name based on
1581
1063
# the current name
1582
alt_interface = attribute._dbus_interface.replace(
1583
orig_interface_name, alt_interface_name)
1064
alt_interface = (attribute._dbus_interface
1065
.replace(orig_interface_name,
1066
alt_interface_name))
1584
1067
interface_names.add(alt_interface)
1585
1068
# Is this a D-Bus signal?
1586
1069
if getattr(attribute, "_dbus_is_signal", False):
1587
# Extract the original non-method undecorated
1588
# function by black magic
1589
if sys.version_info.major == 2:
1590
nonmethod_func = (dict(
1070
# Extract the original non-method function by
1072
nonmethod_func = (dict(
1591
1073
zip(attribute.func_code.co_freevars,
1592
attribute.__closure__))
1593
["func"].cell_contents)
1595
nonmethod_func = (dict(
1596
zip(attribute.__code__.co_freevars,
1597
attribute.__closure__))
1598
["func"].cell_contents)
1074
attribute.__closure__))["func"]
1599
1076
# Create a new, but exactly alike, function
1600
1077
# object, and decorate it to be a new D-Bus signal
1601
1078
# with the alternate D-Bus interface name
1602
new_function = copy_function(nonmethod_func)
1603
new_function = (dbus.service.signal(
1605
attribute._dbus_signature)(new_function))
1079
new_function = (dbus.service.signal
1081
attribute._dbus_signature)
1082
(types.FunctionType(
1083
nonmethod_func.func_code,
1084
nonmethod_func.func_globals,
1085
nonmethod_func.func_name,
1086
nonmethod_func.func_defaults,
1087
nonmethod_func.func_closure)))
1606
1088
# Copy annotations, if any
1608
new_function._dbus_annotations = dict(
1609
attribute._dbus_annotations)
1090
new_function._dbus_annotations = (
1091
dict(attribute._dbus_annotations))
1610
1092
except AttributeError:
1613
1094
# Define a creator of a function to call both the
1614
1095
# original and alternate functions, so both the
1615
1096
# original and alternate signals gets sent when
1698
1186
if interface_names:
1699
1187
# Replace the class with a new subclass of it with
1700
1188
# methods, signals, etc. as created above.
1701
if sys.version_info.major == 2:
1702
cls = type(b"{}Alternate".format(cls.__name__),
1705
cls = type("{}Alternate".format(cls.__name__),
1189
cls = type(b"{0}Alternate".format(cls.__name__),
1712
1195
@alternate_dbus_interfaces({"se.recompile.Mandos":
1713
"se.bsnet.fukt.Mandos"})
1196
"se.bsnet.fukt.Mandos"})
1714
1197
class ClientDBus(Client, DBusObjectWithProperties):
1715
1198
"""A Client class using D-Bus
1718
1201
dbus_object_path: dbus.ObjectPath
1719
1202
bus: dbus.SystemBus()
1722
1205
runtime_expansions = (Client.runtime_expansions
1723
+ ("dbus_object_path", ))
1725
_interface = "se.recompile.Mandos.Client"
1206
+ ("dbus_object_path",))
1727
1208
# dbus.service.Object doesn't use super(), so we can't either.
1729
def __init__(self, bus=None, *args, **kwargs):
1210
def __init__(self, bus = None, *args, **kwargs):
1731
1212
Client.__init__(self, *args, **kwargs)
1732
1213
# Only now, when this client is initialized, can it show up on
1734
client_object_name = str(self.name).translate(
1215
client_object_name = unicode(self.name).translate(
1735
1216
{ord("."): ord("_"),
1736
1217
ord("-"): ord("_")})
1737
self.dbus_object_path = dbus.ObjectPath(
1738
"/clients/" + client_object_name)
1218
self.dbus_object_path = (dbus.ObjectPath
1219
("/clients/" + client_object_name))
1739
1220
DBusObjectWithProperties.__init__(self, self.bus,
1740
1221
self.dbus_object_path)
1742
def notifychangeproperty(transform_func, dbus_name,
1743
type_func=lambda x: x,
1745
invalidate_only=False,
1746
_interface=_interface):
1223
def notifychangeproperty(transform_func,
1224
dbus_name, type_func=lambda x: x,
1747
1226
""" Modify a variable so that it's a property which announces
1748
1227
its changes to DBus.
1750
1229
transform_fun: Function that takes a value and a variant_level
1751
1230
and transforms it to a D-Bus type.
1752
1231
dbus_name: D-Bus name of the variable
1828
1296
if hasattr(DBusObjectWithProperties, "__del__"):
1829
1297
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1830
1298
Client.__del__(self, *args, **kwargs)
1832
def checker_callback(self, source, condition,
1833
connection, command, *args, **kwargs):
1834
ret = Client.checker_callback(self, source, condition,
1835
connection, command, *args,
1837
exitstatus = self.last_checker_status
1300
def checker_callback(self, pid, condition, command,
1302
self.checker_callback_tag = None
1304
if os.WIFEXITED(condition):
1305
exitstatus = os.WEXITSTATUS(condition)
1839
1306
# Emit D-Bus signal
1840
1307
self.CheckerCompleted(dbus.Int16(exitstatus),
1841
# This is specific to GNU libC
1842
dbus.Int64(exitstatus << 8),
1308
dbus.Int64(condition),
1843
1309
dbus.String(command))
1845
1311
# Emit D-Bus signal
1846
1312
self.CheckerCompleted(dbus.Int16(-1),
1848
# This is specific to GNU libC
1850
| self.last_checker_signal),
1313
dbus.Int64(condition),
1851
1314
dbus.String(command))
1316
return Client.checker_callback(self, pid, condition, command,
1854
1319
def start_checker(self, *args, **kwargs):
1855
old_checker_pid = getattr(self.checker, "pid", None)
1320
old_checker = self.checker
1321
if self.checker is not None:
1322
old_checker_pid = self.checker.pid
1324
old_checker_pid = None
1856
1325
r = Client.start_checker(self, *args, **kwargs)
1857
1326
# Only if new checker process was started
1858
1327
if (self.checker is not None
1904
1379
server to mandos-client
1908
1383
# Rejected - signal
1909
1384
@dbus.service.signal(_interface, signature="s")
1910
1385
def Rejected(self, reason):
1914
1389
# NeedApproval - signal
1915
1390
@dbus.service.signal(_interface, signature="tb")
1916
1391
def NeedApproval(self, timeout, default):
1918
1393
return self.need_approval()
1922
1397
# Approve - method
1923
1398
@dbus.service.method(_interface, in_signature="b")
1924
1399
def Approve(self, value):
1925
1400
self.approve(value)
1927
1402
# CheckedOK - method
1928
1403
@dbus.service.method(_interface)
1929
1404
def CheckedOK(self):
1930
1405
self.checked_ok()
1932
1407
# Enable - method
1933
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1934
1408
@dbus.service.method(_interface)
1935
1409
def Enable(self):
1939
1413
# StartChecker - method
1940
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1941
1414
@dbus.service.method(_interface)
1942
1415
def StartChecker(self):
1944
1417
self.start_checker()
1946
1419
# Disable - method
1947
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1948
1420
@dbus.service.method(_interface)
1949
1421
def Disable(self):
1953
1425
# StopChecker - method
1954
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1955
1426
@dbus.service.method(_interface)
1956
1427
def StopChecker(self):
1957
1428
self.stop_checker()
1961
1432
# ApprovalPending - property
1962
1433
@dbus_service_property(_interface, signature="b", access="read")
1963
1434
def ApprovalPending_dbus_property(self):
1964
1435
return dbus.Boolean(bool(self.approvals_pending))
1966
1437
# ApprovedByDefault - property
1967
@dbus_service_property(_interface,
1438
@dbus_service_property(_interface, signature="b",
1969
1439
access="readwrite")
1970
1440
def ApprovedByDefault_dbus_property(self, value=None):
1971
1441
if value is None: # get
1972
1442
return dbus.Boolean(self.approved_by_default)
1973
1443
self.approved_by_default = bool(value)
1975
1445
# ApprovalDelay - property
1976
@dbus_service_property(_interface,
1446
@dbus_service_property(_interface, signature="t",
1978
1447
access="readwrite")
1979
1448
def ApprovalDelay_dbus_property(self, value=None):
1980
1449
if value is None: # get
1981
return dbus.UInt64(self.approval_delay.total_seconds()
1450
return dbus.UInt64(self.approval_delay_milliseconds())
1983
1451
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1985
1453
# ApprovalDuration - property
1986
@dbus_service_property(_interface,
1454
@dbus_service_property(_interface, signature="t",
1988
1455
access="readwrite")
1989
1456
def ApprovalDuration_dbus_property(self, value=None):
1990
1457
if value is None: # get
1991
return dbus.UInt64(self.approval_duration.total_seconds()
1458
return dbus.UInt64(timedelta_to_milliseconds(
1459
self.approval_duration))
1993
1460
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1995
1462
# Name - property
1997
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1998
1463
@dbus_service_property(_interface, signature="s", access="read")
1999
1464
def Name_dbus_property(self):
2000
1465
return dbus.String(self.name)
2002
1467
# Fingerprint - property
2004
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2005
1468
@dbus_service_property(_interface, signature="s", access="read")
2006
1469
def Fingerprint_dbus_property(self):
2007
1470
return dbus.String(self.fingerprint)
2009
1472
# Host - property
2010
@dbus_service_property(_interface,
1473
@dbus_service_property(_interface, signature="s",
2012
1474
access="readwrite")
2013
1475
def Host_dbus_property(self, value=None):
2014
1476
if value is None: # get
2015
1477
return dbus.String(self.host)
2016
self.host = str(value)
1478
self.host = unicode(value)
2018
1480
# Created - property
2020
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2021
1481
@dbus_service_property(_interface, signature="s", access="read")
2022
1482
def Created_dbus_property(self):
2023
1483
return datetime_to_dbus(self.created)
2025
1485
# LastEnabled - property
2026
1486
@dbus_service_property(_interface, signature="s", access="read")
2027
1487
def LastEnabled_dbus_property(self):
2028
1488
return datetime_to_dbus(self.last_enabled)
2030
1490
# Enabled - property
2031
@dbus_service_property(_interface,
1491
@dbus_service_property(_interface, signature="b",
2033
1492
access="readwrite")
2034
1493
def Enabled_dbus_property(self, value=None):
2035
1494
if value is None: # get
2042
1501
# LastCheckedOK - property
2043
@dbus_service_property(_interface,
1502
@dbus_service_property(_interface, signature="s",
2045
1503
access="readwrite")
2046
1504
def LastCheckedOK_dbus_property(self, value=None):
2047
1505
if value is not None:
2048
1506
self.checked_ok()
2050
1508
return datetime_to_dbus(self.last_checked_ok)
2052
1510
# LastCheckerStatus - property
2053
@dbus_service_property(_interface, signature="n", access="read")
1511
@dbus_service_property(_interface, signature="n",
2054
1513
def LastCheckerStatus_dbus_property(self):
2055
1514
return dbus.Int16(self.last_checker_status)
2057
1516
# Expires - property
2058
1517
@dbus_service_property(_interface, signature="s", access="read")
2059
1518
def Expires_dbus_property(self):
2060
1519
return datetime_to_dbus(self.expires)
2062
1521
# LastApprovalRequest - property
2063
1522
@dbus_service_property(_interface, signature="s", access="read")
2064
1523
def LastApprovalRequest_dbus_property(self):
2065
1524
return datetime_to_dbus(self.last_approval_request)
2067
1526
# Timeout - property
2068
@dbus_service_property(_interface,
1527
@dbus_service_property(_interface, signature="t",
2070
1528
access="readwrite")
2071
1529
def Timeout_dbus_property(self, value=None):
2072
1530
if value is None: # get
2073
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2074
old_timeout = self.timeout
1531
return dbus.UInt64(self.timeout_milliseconds())
2075
1532
self.timeout = datetime.timedelta(0, 0, 0, value)
2076
# Reschedule disabling
1533
# Reschedule timeout
2077
1534
if self.enabled:
2078
1535
now = datetime.datetime.utcnow()
2079
self.expires += self.timeout - old_timeout
2080
if self.expires <= now:
1536
time_to_die = timedelta_to_milliseconds(
1537
(self.last_checked_ok + self.timeout) - now)
1538
if time_to_die <= 0:
2081
1539
# The timeout has passed
1542
self.expires = (now +
1543
datetime.timedelta(milliseconds =
2084
1545
if (getattr(self, "disable_initiator_tag", None)
2087
GLib.source_remove(self.disable_initiator_tag)
2088
self.disable_initiator_tag = GLib.timeout_add(
2089
int((self.expires - now).total_seconds() * 1000),
1548
gobject.source_remove(self.disable_initiator_tag)
1549
self.disable_initiator_tag = (gobject.timeout_add
2092
1553
# ExtendedTimeout - property
2093
@dbus_service_property(_interface,
1554
@dbus_service_property(_interface, signature="t",
2095
1555
access="readwrite")
2096
1556
def ExtendedTimeout_dbus_property(self, value=None):
2097
1557
if value is None: # get
2098
return dbus.UInt64(self.extended_timeout.total_seconds()
1558
return dbus.UInt64(self.extended_timeout_milliseconds())
2100
1559
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2102
1561
# Interval - property
2103
@dbus_service_property(_interface,
1562
@dbus_service_property(_interface, signature="t",
2105
1563
access="readwrite")
2106
1564
def Interval_dbus_property(self, value=None):
2107
1565
if value is None: # get
2108
return dbus.UInt64(self.interval.total_seconds() * 1000)
1566
return dbus.UInt64(self.interval_milliseconds())
2109
1567
self.interval = datetime.timedelta(0, 0, 0, value)
2110
1568
if getattr(self, "checker_initiator_tag", None) is None:
2112
1570
if self.enabled:
2113
1571
# Reschedule checker run
2114
GLib.source_remove(self.checker_initiator_tag)
2115
self.checker_initiator_tag = GLib.timeout_add(
2116
value, self.start_checker)
2117
self.start_checker() # Start one now, too
1572
gobject.source_remove(self.checker_initiator_tag)
1573
self.checker_initiator_tag = (gobject.timeout_add
1574
(value, self.start_checker))
1575
self.start_checker() # Start one now, too
2119
1577
# Checker - property
2120
@dbus_service_property(_interface,
1578
@dbus_service_property(_interface, signature="s",
2122
1579
access="readwrite")
2123
1580
def Checker_dbus_property(self, value=None):
2124
1581
if value is None: # get
2125
1582
return dbus.String(self.checker_command)
2126
self.checker_command = str(value)
1583
self.checker_command = unicode(value)
2128
1585
# CheckerRunning - property
2129
@dbus_service_property(_interface,
1586
@dbus_service_property(_interface, signature="b",
2131
1587
access="readwrite")
2132
1588
def CheckerRunning_dbus_property(self, value=None):
2133
1589
if value is None: # get
2190
1636
class ClientHandler(socketserver.BaseRequestHandler, object):
2191
1637
"""A class to handle client connections.
2193
1639
Instantiated once for each connection to handle it.
2194
1640
Note: This will run in its own forked process."""
2196
1642
def handle(self):
2197
1643
with contextlib.closing(self.server.child_pipe) as child_pipe:
2198
1644
logger.info("TCP connection from: %s",
2199
str(self.client_address))
1645
unicode(self.client_address))
2200
1646
logger.debug("Pipe FD: %d",
2201
1647
self.server.child_pipe.fileno())
2203
session = gnutls.ClientSession(self.request)
2205
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2206
# "+AES-256-CBC", "+SHA1",
2207
# "+COMP-NULL", "+CTYPE-OPENPGP",
1649
session = (gnutls.connection
1650
.ClientSession(self.request,
1652
.X509Credentials()))
1654
# Note: gnutls.connection.X509Credentials is really a
1655
# generic GnuTLS certificate credentials object so long as
1656
# no X.509 keys are added to it. Therefore, we can use it
1657
# here despite using OpenPGP certificates.
1659
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1660
# "+AES-256-CBC", "+SHA1",
1661
# "+COMP-NULL", "+CTYPE-OPENPGP",
2209
1663
# Use a fallback default, since this MUST be set.
2210
1664
priority = self.server.gnutls_priority
2211
1665
if priority is None:
2212
1666
priority = "NORMAL"
2213
gnutls.priority_set_direct(session._c_object,
2214
priority.encode("utf-8"),
1667
(gnutls.library.functions
1668
.gnutls_priority_set_direct(session._c_object,
2217
1671
# Start communication using the Mandos protocol
2218
1672
# Get protocol number
2219
1673
line = self.request.makefile().readline()
2220
1674
logger.debug("Protocol version: %r", line)
2222
1676
if int(line.strip().split()[0]) > 1:
2223
raise RuntimeError(line)
2224
1678
except (ValueError, IndexError, RuntimeError) as error:
2225
1679
logger.error("Unknown protocol version: %s", error)
2228
1682
# Start GnuTLS connection
2230
1684
session.handshake()
2231
except gnutls.Error as error:
1685
except gnutls.errors.GNUTLSError as error:
2232
1686
logger.warning("Handshake failed: %s", error)
2233
1687
# Do not run session.bye() here: the session is not
2234
1688
# established. Just abandon the request.
2236
1690
logger.debug("Handshake succeeded")
2238
1692
approval_required = False
2241
fpr = self.fingerprint(
2242
self.peer_certificate(session))
2243
except (TypeError, gnutls.Error) as error:
1695
fpr = self.fingerprint(self.peer_certificate
1698
gnutls.errors.GNUTLSError) as error:
2244
1699
logger.warning("Bad certificate: %s", error)
2246
1701
logger.debug("Fingerprint: %s", fpr)
2249
1704
client = ProxyClient(child_pipe, fpr,
2250
1705
self.client_address)
2251
1706
except KeyError:
2254
1709
if client.approval_delay:
2255
1710
delay = client.approval_delay
2256
1711
client.approvals_pending += 1
2257
1712
approval_required = True
2260
1715
if not client.enabled:
2261
1716
logger.info("Client %s is disabled",
2263
1718
if self.server.use_dbus:
2264
1719
# Emit D-Bus signal
2265
1720
client.Rejected("Disabled")
2268
1723
if client.approved or not client.approval_delay:
2269
# We are approved or approval is disabled
1724
#We are approved or approval is disabled
2271
1726
elif client.approved is None:
2272
1727
logger.info("Client %s needs approval",
2305
1762
delay -= time2 - time
2308
session.send(client.secret)
2309
except gnutls.Error as error:
2310
logger.warning("gnutls send failed",
1765
while sent_size < len(client.secret):
1767
sent = session.send(client.secret[sent_size:])
1768
except gnutls.errors.GNUTLSError as error:
1769
logger.warning("gnutls send failed",
1772
logger.debug("Sent: %d, remaining: %d",
1773
sent, len(client.secret)
1774
- (sent_size + sent))
2314
1777
logger.info("Sending secret to %s", client.name)
2315
1778
# bump the timeout using extended_timeout
2316
1779
client.bump_timeout(client.extended_timeout)
2317
1780
if self.server.use_dbus:
2318
1781
# Emit D-Bus signal
2319
1782
client.GotSecret()
2322
1785
if approval_required:
2323
1786
client.approvals_pending -= 1
2326
except gnutls.Error as error:
1789
except gnutls.errors.GNUTLSError as error:
2327
1790
logger.warning("GnuTLS bye failed",
2328
1791
exc_info=error)
2331
1794
def peer_certificate(session):
2332
1795
"Return the peer's OpenPGP certificate as a bytestring"
2333
1796
# If not an OpenPGP certificate...
2334
if (gnutls.certificate_type_get(session._c_object)
2335
!= gnutls.CRT_OPENPGP):
2336
# ...return invalid data
1797
if (gnutls.library.functions
1798
.gnutls_certificate_type_get(session._c_object)
1799
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1800
# ...do the normal thing
1801
return session.peer_certificate
2338
1802
list_size = ctypes.c_uint(1)
2339
cert_list = (gnutls.certificate_get_peers
1803
cert_list = (gnutls.library.functions
1804
.gnutls_certificate_get_peers
2340
1805
(session._c_object, ctypes.byref(list_size)))
2341
1806
if not bool(cert_list) and list_size.value != 0:
2342
raise gnutls.Error("error getting peer certificate")
1807
raise gnutls.errors.GNUTLSError("error getting peer"
2343
1809
if list_size.value == 0:
2345
1811
cert = cert_list[0]
2346
1812
return ctypes.string_at(cert.data, cert.size)
2349
1815
def fingerprint(openpgp):
2350
1816
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2351
1817
# New GnuTLS "datum" with the OpenPGP public key
2352
datum = gnutls.datum_t(
2353
ctypes.cast(ctypes.c_char_p(openpgp),
2354
ctypes.POINTER(ctypes.c_ubyte)),
2355
ctypes.c_uint(len(openpgp)))
1818
datum = (gnutls.library.types
1819
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1822
ctypes.c_uint(len(openpgp))))
2356
1823
# New empty GnuTLS certificate
2357
crt = gnutls.openpgp_crt_t()
2358
gnutls.openpgp_crt_init(ctypes.byref(crt))
1824
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1825
(gnutls.library.functions
1826
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2359
1827
# Import the OpenPGP public key into the certificate
2360
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2361
gnutls.OPENPGP_FMT_RAW)
1828
(gnutls.library.functions
1829
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1830
gnutls.library.constants
1831
.GNUTLS_OPENPGP_FMT_RAW))
2362
1832
# Verify the self signature in the key
2363
1833
crtverify = ctypes.c_uint()
2364
gnutls.openpgp_crt_verify_self(crt, 0,
2365
ctypes.byref(crtverify))
1834
(gnutls.library.functions
1835
.gnutls_openpgp_crt_verify_self(crt, 0,
1836
ctypes.byref(crtverify)))
2366
1837
if crtverify.value != 0:
2367
gnutls.openpgp_crt_deinit(crt)
2368
raise gnutls.CertificateSecurityError("Verify failed")
1838
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1839
raise (gnutls.errors.CertificateSecurityError
2369
1841
# New buffer for the fingerprint
2370
1842
buf = ctypes.create_string_buffer(20)
2371
1843
buf_len = ctypes.c_size_t()
2372
1844
# Get the fingerprint from the certificate into the buffer
2373
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2374
ctypes.byref(buf_len))
1845
(gnutls.library.functions
1846
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1847
ctypes.byref(buf_len)))
2375
1848
# Deinit the certificate
2376
gnutls.openpgp_crt_deinit(crt)
1849
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2377
1850
# Convert the buffer to a Python bytestring
2378
1851
fpr = ctypes.string_at(buf, buf_len.value)
2379
1852
# Convert the bytestring to hexadecimal notation
2384
1857
class MultiprocessingMixIn(object):
2385
1858
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2387
1859
def sub_process_main(self, request, address):
2389
1861
self.finish_request(request, address)
2390
1862
except Exception:
2391
1863
self.handle_error(request, address)
2392
1864
self.close_request(request)
2394
1866
def process_request(self, request, address):
2395
1867
"""Start a new process to process the request."""
2396
proc = multiprocessing.Process(target=self.sub_process_main,
2397
args=(request, address))
1868
proc = multiprocessing.Process(target = self.sub_process_main,
1869
args = (request, address))
2402
1874
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2403
1875
""" adds a pipe to the MixIn """
2405
1876
def process_request(self, request, client_address):
2406
1877
"""Overrides and wraps the original process_request().
2408
1879
This function creates a new pipe in self.pipe
2410
1881
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2412
1883
proc = MultiprocessingMixIn.process_request(self, request,
2413
1884
client_address)
2414
1885
self.child_pipe.close()
2415
1886
self.add_pipe(parent_pipe, proc)
2417
1888
def add_pipe(self, parent_pipe, proc):
2418
1889
"""Dummy function; override as necessary"""
2419
raise NotImplementedError()
1890
raise NotImplementedError
2422
1893
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2423
1894
socketserver.TCPServer, object):
2424
1895
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2427
1898
enabled: Boolean; whether this server is activated yet
2428
1899
interface: None or a network interface name (string)
2429
1900
use_ipv6: Boolean; to use IPv6 or not
2432
1902
def __init__(self, server_address, RequestHandlerClass,
2436
"""If socketfd is set, use that file descriptor instead of
2437
creating a new one with socket.socket().
1903
interface=None, use_ipv6=True):
2439
1904
self.interface = interface
2441
1906
self.address_family = socket.AF_INET6
2442
if socketfd is not None:
2443
# Save the file descriptor
2444
self.socketfd = socketfd
2445
# Save the original socket.socket() function
2446
self.socket_socket = socket.socket
2448
# To implement --socket, we monkey patch socket.socket.
2450
# (When socketserver.TCPServer is a new-style class, we
2451
# could make self.socket into a property instead of monkey
2452
# patching socket.socket.)
2454
# Create a one-time-only replacement for socket.socket()
2455
@functools.wraps(socket.socket)
2456
def socket_wrapper(*args, **kwargs):
2457
# Restore original function so subsequent calls are
2459
socket.socket = self.socket_socket
2460
del self.socket_socket
2461
# This time only, return a new socket object from the
2462
# saved file descriptor.
2463
return socket.fromfd(self.socketfd, *args, **kwargs)
2464
# Replace socket.socket() function with wrapper
2465
socket.socket = socket_wrapper
2466
# The socketserver.TCPServer.__init__ will call
2467
# socket.socket(), which might be our replacement,
2468
# socket_wrapper(), if socketfd was set.
2469
1907
socketserver.TCPServer.__init__(self, server_address,
2470
1908
RequestHandlerClass)
2472
1909
def server_bind(self):
2473
1910
"""This overrides the normal server_bind() function
2474
1911
to bind to an interface if one was specified, and also NOT to
2475
1912
bind to an address or port if they were not specified."""
2476
global SO_BINDTODEVICE
2477
1913
if self.interface is not None:
2478
1914
if SO_BINDTODEVICE is None:
2479
# Fall back to a hard-coded value which seems to be
2481
logger.warning("SO_BINDTODEVICE not found, trying 25")
2482
SO_BINDTODEVICE = 25
2484
self.socket.setsockopt(
2485
socket.SOL_SOCKET, SO_BINDTODEVICE,
2486
(self.interface + "\0").encode("utf-8"))
2487
except socket.error as error:
2488
if error.errno == errno.EPERM:
2489
logger.error("No permission to bind to"
2490
" interface %s", self.interface)
2491
elif error.errno == errno.ENOPROTOOPT:
2492
logger.error("SO_BINDTODEVICE not available;"
2493
" cannot bind to interface %s",
2495
elif error.errno == errno.ENODEV:
2496
logger.error("Interface %s does not exist,"
2497
" cannot bind", self.interface)
1915
logger.error("SO_BINDTODEVICE does not exist;"
1916
" cannot bind to interface %s",
1920
self.socket.setsockopt(socket.SOL_SOCKET,
1924
except socket.error as error:
1925
if error[0] == errno.EPERM:
1926
logger.error("No permission to"
1927
" bind to interface %s",
1929
elif error[0] == errno.ENOPROTOOPT:
1930
logger.error("SO_BINDTODEVICE not available;"
1931
" cannot bind to interface %s",
2500
1935
# Only bind(2) the socket if we really need to.
2501
1936
if self.server_address[0] or self.server_address[1]:
2502
1937
if not self.server_address[0]:
2503
1938
if self.address_family == socket.AF_INET6:
2504
any_address = "::" # in6addr_any
1939
any_address = "::" # in6addr_any
2506
any_address = "0.0.0.0" # INADDR_ANY
1941
any_address = socket.INADDR_ANY
2507
1942
self.server_address = (any_address,
2508
1943
self.server_address[1])
2509
1944
elif not self.server_address[1]:
2510
self.server_address = (self.server_address[0], 0)
1945
self.server_address = (self.server_address[0],
2511
1947
# if self.interface:
2512
1948
# self.server_address = (self.server_address[0],
2610
2038
funcname = request[1]
2611
2039
args = request[2]
2612
2040
kwargs = request[3]
2614
2042
parent_pipe.send(('data', getattr(client_object,
2615
2043
funcname)(*args,
2618
2046
if command == 'getattr':
2619
2047
attrname = request[1]
2620
if isinstance(client_object.__getattribute__(attrname),
2621
collections.Callable):
2622
parent_pipe.send(('function', ))
2048
if callable(client_object.__getattribute__(attrname)):
2049
parent_pipe.send(('function',))
2625
'data', client_object.__getattribute__(attrname)))
2051
parent_pipe.send(('data', client_object
2052
.__getattribute__(attrname)))
2627
2054
if command == 'setattr':
2628
2055
attrname = request[1]
2629
2056
value = request[2]
2630
2057
setattr(client_object, attrname, value)
2635
def rfc3339_duration_to_delta(duration):
2636
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2638
>>> rfc3339_duration_to_delta("P7D")
2639
datetime.timedelta(7)
2640
>>> rfc3339_duration_to_delta("PT60S")
2641
datetime.timedelta(0, 60)
2642
>>> rfc3339_duration_to_delta("PT60M")
2643
datetime.timedelta(0, 3600)
2644
>>> rfc3339_duration_to_delta("PT24H")
2645
datetime.timedelta(1)
2646
>>> rfc3339_duration_to_delta("P1W")
2647
datetime.timedelta(7)
2648
>>> rfc3339_duration_to_delta("PT5M30S")
2649
datetime.timedelta(0, 330)
2650
>>> rfc3339_duration_to_delta("P1DT3M20S")
2651
datetime.timedelta(1, 200)
2654
# Parsing an RFC 3339 duration with regular expressions is not
2655
# possible - there would have to be multiple places for the same
2656
# values, like seconds. The current code, while more esoteric, is
2657
# cleaner without depending on a parsing library. If Python had a
2658
# built-in library for parsing we would use it, but we'd like to
2659
# avoid excessive use of external libraries.
2661
# New type for defining tokens, syntax, and semantics all-in-one
2662
Token = collections.namedtuple("Token", (
2663
"regexp", # To match token; if "value" is not None, must have
2664
# a "group" containing digits
2665
"value", # datetime.timedelta or None
2666
"followers")) # Tokens valid after this token
2667
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2668
# the "duration" ABNF definition in RFC 3339, Appendix A.
2669
token_end = Token(re.compile(r"$"), None, frozenset())
2670
token_second = Token(re.compile(r"(\d+)S"),
2671
datetime.timedelta(seconds=1),
2672
frozenset((token_end, )))
2673
token_minute = Token(re.compile(r"(\d+)M"),
2674
datetime.timedelta(minutes=1),
2675
frozenset((token_second, token_end)))
2676
token_hour = Token(re.compile(r"(\d+)H"),
2677
datetime.timedelta(hours=1),
2678
frozenset((token_minute, token_end)))
2679
token_time = Token(re.compile(r"T"),
2681
frozenset((token_hour, token_minute,
2683
token_day = Token(re.compile(r"(\d+)D"),
2684
datetime.timedelta(days=1),
2685
frozenset((token_time, token_end)))
2686
token_month = Token(re.compile(r"(\d+)M"),
2687
datetime.timedelta(weeks=4),
2688
frozenset((token_day, token_end)))
2689
token_year = Token(re.compile(r"(\d+)Y"),
2690
datetime.timedelta(weeks=52),
2691
frozenset((token_month, token_end)))
2692
token_week = Token(re.compile(r"(\d+)W"),
2693
datetime.timedelta(weeks=1),
2694
frozenset((token_end, )))
2695
token_duration = Token(re.compile(r"P"), None,
2696
frozenset((token_year, token_month,
2697
token_day, token_time,
2699
# Define starting values:
2701
value = datetime.timedelta()
2703
# Following valid tokens
2704
followers = frozenset((token_duration, ))
2705
# String left to parse
2707
# Loop until end token is found
2708
while found_token is not token_end:
2709
# Search for any currently valid tokens
2710
for token in followers:
2711
match = token.regexp.match(s)
2712
if match is not None:
2714
if token.value is not None:
2715
# Value found, parse digits
2716
factor = int(match.group(1), 10)
2717
# Add to value so far
2718
value += factor * token.value
2719
# Strip token from string
2720
s = token.regexp.sub("", s, 1)
2723
# Set valid next tokens
2724
followers = found_token.followers
2727
# No currently valid tokens were found
2728
raise ValueError("Invalid RFC 3339 duration: {!r}"
2734
2062
def string_to_delta(interval):
2735
2063
"""Parse a string and return a datetime.timedelta
2737
2065
>>> string_to_delta('7d')
2738
2066
datetime.timedelta(7)
2739
2067
>>> string_to_delta('60s')
2834
2157
parser.add_argument("--no-dbus", action="store_false",
2835
2158
dest="use_dbus", help="Do not provide D-Bus"
2836
" system bus interface", default=None)
2159
" system bus interface")
2837
2160
parser.add_argument("--no-ipv6", action="store_false",
2838
dest="use_ipv6", help="Do not use IPv6",
2161
dest="use_ipv6", help="Do not use IPv6")
2840
2162
parser.add_argument("--no-restore", action="store_false",
2841
2163
dest="restore", help="Do not restore stored"
2842
" state", default=None)
2843
parser.add_argument("--socket", type=int,
2844
help="Specify a file descriptor to a network"
2845
" socket to use instead of creating one")
2846
2165
parser.add_argument("--statedir", metavar="DIR",
2847
2166
help="Directory to save/restore state in")
2848
parser.add_argument("--foreground", action="store_true",
2849
help="Run in foreground", default=None)
2850
parser.add_argument("--no-zeroconf", action="store_false",
2851
dest="zeroconf", help="Do not use Zeroconf",
2854
2168
options = parser.parse_args()
2856
2170
if options.check:
2858
fail_count, test_count = doctest.testmod()
2859
sys.exit(os.EX_OK if fail_count == 0 else 1)
2861
2175
# Default values for config file for server-global settings
2862
server_defaults = {"interface": "",
2867
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2868
":+SIGN-DSA-SHA256",
2869
"servicename": "Mandos",
2875
"statedir": "/var/lib/mandos",
2876
"foreground": "False",
2176
server_defaults = { "interface": "",
2181
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2182
"servicename": "Mandos",
2187
"statedir": "/var/lib/mandos"
2880
2190
# Parse config file for server-global settings
2881
2191
server_config = configparser.SafeConfigParser(server_defaults)
2882
2192
del server_defaults
2883
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2193
server_config.read(os.path.join(options.configdir,
2884
2195
# Convert the SafeConfigParser object to a dict
2885
2196
server_settings = server_config.defaults()
2886
2197
# Use the appropriate methods on the non-string config options
2887
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2888
"foreground", "zeroconf"):
2198
for option in ("debug", "use_dbus", "use_ipv6"):
2889
2199
server_settings[option] = server_config.getboolean("DEFAULT",
2891
2201
if server_settings["port"]:
2892
2202
server_settings["port"] = server_config.getint("DEFAULT",
2894
if server_settings["socket"]:
2895
server_settings["socket"] = server_config.getint("DEFAULT",
2897
# Later, stdin will, and stdout and stderr might, be dup'ed
2898
# over with an opened os.devnull. But we don't want this to
2899
# happen with a supplied network socket.
2900
if 0 <= server_settings["socket"] <= 2:
2901
server_settings["socket"] = os.dup(server_settings
2903
2204
del server_config
2905
2206
# Override the settings from the config file with command line
2906
2207
# options, if set.
2907
2208
for option in ("interface", "address", "port", "debug",
2908
"priority", "servicename", "configdir", "use_dbus",
2909
"use_ipv6", "debuglevel", "restore", "statedir",
2910
"socket", "foreground", "zeroconf"):
2209
"priority", "servicename", "configdir",
2210
"use_dbus", "use_ipv6", "debuglevel", "restore",
2911
2212
value = getattr(options, option)
2912
2213
if value is not None:
2913
2214
server_settings[option] = value
2915
2216
# Force all strings to be unicode
2916
2217
for option in server_settings.keys():
2917
if isinstance(server_settings[option], bytes):
2918
server_settings[option] = (server_settings[option]
2920
# Force all boolean options to be boolean
2921
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2922
"foreground", "zeroconf"):
2923
server_settings[option] = bool(server_settings[option])
2924
# Debug implies foreground
2925
if server_settings["debug"]:
2926
server_settings["foreground"] = True
2218
if type(server_settings[option]) is str:
2219
server_settings[option] = unicode(server_settings[option])
2927
2220
# Now we have our good server settings in "server_settings"
2929
2222
##################################################################
2931
if (not server_settings["zeroconf"]
2932
and not (server_settings["port"]
2933
or server_settings["socket"] != "")):
2934
parser.error("Needs port or socket to work without Zeroconf")
2936
2224
# For convenience
2937
2225
debug = server_settings["debug"]
2938
2226
debuglevel = server_settings["debuglevel"]
2952
2238
level = getattr(logging, debuglevel.upper())
2953
2239
initlogger(debug, level)
2955
2241
if server_settings["servicename"] != "Mandos":
2956
syslogger.setFormatter(
2957
logging.Formatter('Mandos ({}) [%(process)d]:'
2958
' %(levelname)s: %(message)s'.format(
2959
server_settings["servicename"])))
2242
syslogger.setFormatter(logging.Formatter
2243
('Mandos ({0}) [%(process)d]:'
2244
' %(levelname)s: %(message)s'
2245
.format(server_settings
2961
2248
# Parse config file with clients
2962
2249
client_config = configparser.SafeConfigParser(Client
2963
2250
.client_defaults)
2964
2251
client_config.read(os.path.join(server_settings["configdir"],
2965
2252
"clients.conf"))
2967
2254
global mandos_dbus_service
2968
2255
mandos_dbus_service = None
2971
if server_settings["socket"] != "":
2972
socketfd = server_settings["socket"]
2973
tcp_server = MandosServer(
2974
(server_settings["address"], server_settings["port"]),
2976
interface=(server_settings["interface"] or None),
2978
gnutls_priority=server_settings["priority"],
2982
pidfilename = "/run/mandos.pid"
2983
if not os.path.isdir("/run/."):
2984
pidfilename = "/var/run/mandos.pid"
2257
tcp_server = MandosServer((server_settings["address"],
2258
server_settings["port"]),
2260
interface=(server_settings["interface"]
2264
server_settings["priority"],
2267
pidfilename = "/var/run/mandos.pid"
2987
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2269
pidfile = open(pidfilename, "w")
2988
2270
except IOError as e:
2989
2271
logger.error("Could not open file %r", pidfilename,
2992
for name, group in (("_mandos", "_mandos"),
2993
("mandos", "mandos"),
2994
("nobody", "nogroup")):
2274
for name in ("_mandos", "mandos", "nobody"):
2996
2276
uid = pwd.getpwnam(name).pw_uid
2997
gid = pwd.getpwnam(group).pw_gid
2277
gid = pwd.getpwnam(name).pw_gid
2999
2279
except KeyError:
3008
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3010
2287
except OSError as error:
3011
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3012
.format(uid, gid, os.strerror(error.errno)))
3013
if error.errno != errno.EPERM:
2288
if error[0] != errno.EPERM:
3017
2292
# Enable all possible GnuTLS debugging
3019
2294
# "Use a log level over 10 to enable all debugging options."
3020
2295
# - GnuTLS manual
3021
gnutls.global_set_log_level(11)
2296
gnutls.library.functions.gnutls_global_set_log_level(11)
2298
@gnutls.library.types.gnutls_log_func
3024
2299
def debug_gnutls(level, string):
3025
2300
logger.debug("GnuTLS: %s", string[:-1])
3027
gnutls.global_set_log_function(debug_gnutls)
2302
(gnutls.library.functions
2303
.gnutls_global_set_log_function(debug_gnutls))
3029
2305
# Redirect stdin so all checkers get /dev/null
3030
2306
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3031
2307
os.dup2(null, sys.stdin.fileno())
3035
2311
# Need to fork before connecting to D-Bus
3037
2313
# Close all input and output, do double fork, etc.
3040
# multiprocessing will use threads, so before we use GLib we need
3041
# to inform GLib that threads will be used.
2316
gobject.threads_init()
3044
2318
global main_loop
3045
2319
# From the Avahi example code
3046
2320
DBusGMainLoop(set_as_default=True)
3047
main_loop = GLib.MainLoop()
2321
main_loop = gobject.MainLoop()
3048
2322
bus = dbus.SystemBus()
3049
2323
# End of Avahi example code
3052
2326
bus_name = dbus.service.BusName("se.recompile.Mandos",
3055
old_bus_name = dbus.service.BusName(
3056
"se.bsnet.fukt.Mandos", bus,
3058
except dbus.exceptions.DBusException as e:
2327
bus, do_not_queue=True)
2328
old_bus_name = (dbus.service.BusName
2329
("se.bsnet.fukt.Mandos", bus,
2331
except dbus.exceptions.NameExistsException as e:
3059
2332
logger.error("Disabling D-Bus:", exc_info=e)
3060
2333
use_dbus = False
3061
2334
server_settings["use_dbus"] = False
3062
2335
tcp_server.use_dbus = False
3064
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3065
service = AvahiServiceToSyslog(
3066
name=server_settings["servicename"],
3067
servicetype="_mandos._tcp",
3070
if server_settings["interface"]:
3071
service.interface = if_nametoindex(
3072
server_settings["interface"].encode("utf-8"))
2336
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2337
service = AvahiServiceToSyslog(name =
2338
server_settings["servicename"],
2339
servicetype = "_mandos._tcp",
2340
protocol = protocol, bus = bus)
2341
if server_settings["interface"]:
2342
service.interface = (if_nametoindex
2343
(str(server_settings["interface"])))
3074
2345
global multiprocessing_manager
3075
2346
multiprocessing_manager = multiprocessing.Manager()
3077
2348
client_class = Client
3079
client_class = functools.partial(ClientDBus, bus=bus)
2350
client_class = functools.partial(ClientDBus, bus = bus)
3081
2352
client_settings = Client.config_parser(client_config)
3082
2353
old_client_settings = {}
3083
2354
clients_data = {}
3085
# This is used to redirect stdout and stderr for checker processes
3087
wnull = open(os.devnull, "w") # A writable /dev/null
3088
# Only used if server is running in foreground but not in debug
3090
if debug or not foreground:
3093
2356
# Get client data and settings from last running state.
3094
2357
if server_settings["restore"]:
3096
2359
with open(stored_state_path, "rb") as stored_state:
3097
if sys.version_info.major == 2:
3098
clients_data, old_client_settings = pickle.load(
3101
bytes_clients_data, bytes_old_client_settings = (
3102
pickle.load(stored_state, encoding="bytes"))
3103
# Fix bytes to strings
3106
clients_data = {(key.decode("utf-8")
3107
if isinstance(key, bytes)
3110
bytes_clients_data.items()}
3111
del bytes_clients_data
3112
for key in clients_data:
3113
value = {(k.decode("utf-8")
3114
if isinstance(k, bytes) else k): v
3116
clients_data[key].items()}
3117
clients_data[key] = value
3119
value["client_structure"] = [
3121
if isinstance(s, bytes)
3123
value["client_structure"]]
3125
for k in ("name", "host"):
3126
if isinstance(value[k], bytes):
3127
value[k] = value[k].decode("utf-8")
3128
# old_client_settings
3130
old_client_settings = {
3131
(key.decode("utf-8")
3132
if isinstance(key, bytes)
3135
bytes_old_client_settings.items()}
3136
del bytes_old_client_settings
3138
for value in old_client_settings.values():
3139
if isinstance(value["host"], bytes):
3140
value["host"] = (value["host"]
2360
clients_data, old_client_settings = (pickle.load
3142
2362
os.remove(stored_state_path)
3143
2363
except IOError as e:
3144
2364
if e.errno == errno.ENOENT:
3145
logger.warning("Could not load persistent state:"
3146
" {}".format(os.strerror(e.errno)))
2365
logger.warning("Could not load persistent state: {0}"
2366
.format(os.strerror(e.errno)))
3148
2368
logger.critical("Could not load persistent state:",
3151
2371
except EOFError as e:
3152
2372
logger.warning("Could not load persistent state: "
2373
"EOFError:", exc_info=e)
3156
2375
with PGPEngine() as pgp:
3157
for client_name, client in clients_data.items():
3158
# Skip removed clients
3159
if client_name not in client_settings:
2376
for client_name, client in clients_data.iteritems():
3162
2377
# Decide which value to use after restoring saved state.
3163
2378
# We have three different values: Old config file,
3164
2379
# new config file, and saved state.
3222
2437
for client_name in (set(client_settings)
3223
2438
- set(old_client_settings)):
3224
2439
clients_data[client_name] = client_settings[client_name]
3226
2441
# Create all client objects
3227
for client_name, client in clients_data.items():
2442
for client_name, client in clients_data.iteritems():
3228
2443
tcp_server.clients[client_name] = client_class(
3231
server_settings=server_settings)
2444
name = client_name, settings = client)
3233
2446
if not tcp_server.clients:
3234
2447
logger.warning("No clients defined")
3237
if pidfile is not None:
3241
print(pid, file=pidfile)
3243
logger.error("Could not write to file %r with PID %d",
2453
pidfile.write(str(pid) + "\n".encode("utf-8"))
2456
logger.error("Could not write to file %r with PID %d",
2459
# "pidfile" was never created
3246
2461
del pidfilename
3248
for termsig in (signal.SIGHUP, signal.SIGTERM):
3249
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3250
lambda: main_loop.quit() and False)
2462
signal.signal(signal.SIGINT, signal.SIG_IGN)
2464
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2465
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3254
@alternate_dbus_interfaces(
3255
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3256
class MandosDBusService(DBusObjectWithObjectManager):
2468
@alternate_dbus_interfaces({"se.recompile.Mandos":
2469
"se.bsnet.fukt.Mandos"})
2470
class MandosDBusService(DBusObjectWithProperties):
3257
2471
"""A D-Bus proxy object"""
3259
2472
def __init__(self):
3260
2473
dbus.service.Object.__init__(self, bus, "/")
3262
2474
_interface = "se.recompile.Mandos"
2476
@dbus_interface_annotations(_interface)
2478
return { "org.freedesktop.DBus.Property"
2479
".EmitsChangedSignal":
3264
2482
@dbus.service.signal(_interface, signature="o")
3265
2483
def ClientAdded(self, objpath):
3269
2487
@dbus.service.signal(_interface, signature="ss")
3270
2488
def ClientNotFound(self, fingerprint, address):
3274
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3276
2492
@dbus.service.signal(_interface, signature="os")
3277
2493
def ClientRemoved(self, objpath, name):
3281
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3283
2497
@dbus.service.method(_interface, out_signature="ao")
3284
2498
def GetAllClients(self):
3286
return dbus.Array(c.dbus_object_path for c in
3287
tcp_server.clients.values())
3289
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2500
return dbus.Array(c.dbus_object_path
2502
tcp_server.clients.itervalues())
3291
2504
@dbus.service.method(_interface,
3292
2505
out_signature="a{oa{sv}}")
3293
2506
def GetAllClientsWithProperties(self):
3295
2508
return dbus.Dictionary(
3296
{c.dbus_object_path: c.GetAll(
3297
"se.recompile.Mandos.Client")
3298
for c in tcp_server.clients.values()},
2509
((c.dbus_object_path, c.GetAll(""))
2510
for c in tcp_server.clients.itervalues()),
3299
2511
signature="oa{sv}")
3301
2513
@dbus.service.method(_interface, in_signature="o")
3302
2514
def RemoveClient(self, object_path):
3304
for c in tcp_server.clients.values():
2516
for c in tcp_server.clients.itervalues():
3305
2517
if c.dbus_object_path == object_path:
3306
2518
del tcp_server.clients[c.name]
3307
2519
c.remove_from_connection()
3308
# Don't signal the disabling
2520
# Don't signal anything except ClientRemoved
3309
2521
c.disable(quiet=True)
3310
# Emit D-Bus signal for removal
3311
self.client_removed_signal(c)
2523
self.ClientRemoved(object_path, c.name)
3313
2525
raise KeyError(object_path)
3317
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3318
out_signature="a{oa{sa{sv}}}")
3319
def GetManagedObjects(self):
3321
return dbus.Dictionary(
3322
{client.dbus_object_path:
3324
{interface: client.GetAll(interface)
3326
client._get_all_interface_names()})
3327
for client in tcp_server.clients.values()})
3329
def client_added_signal(self, client):
3330
"""Send the new standard signal and the old signal"""
3332
# New standard signal
3333
self.InterfacesAdded(
3334
client.dbus_object_path,
3336
{interface: client.GetAll(interface)
3338
client._get_all_interface_names()}))
3340
self.ClientAdded(client.dbus_object_path)
3342
def client_removed_signal(self, client):
3343
"""Send the new standard signal and the old signal"""
3345
# New standard signal
3346
self.InterfacesRemoved(
3347
client.dbus_object_path,
3348
client._get_all_interface_names())
3350
self.ClientRemoved(client.dbus_object_path,
3353
2529
mandos_dbus_service = MandosDBusService()
3355
# Save modules to variables to exempt the modules from being
3356
# unloaded before the function registered with atexit() is run.
3357
mp = multiprocessing
3361
2532
"Cleanup function; run on exit"
3365
mp.active_children()
2535
multiprocessing.active_children()
3367
2536
if not (tcp_server.clients or client_settings):
3370
2539
# Store client before exiting. Secrets are encrypted with key
3371
2540
# based on what config file has. If config file is
3372
2541
# removed/edited, old secret will thus be unrecovable.
3374
2543
with PGPEngine() as pgp:
3375
for client in tcp_server.clients.values():
2544
for client in tcp_server.clients.itervalues():
3376
2545
key = client_settings[client.name]["secret"]
3377
2546
client.encrypted_secret = pgp.encrypt(client.secret,
3379
2548
client_dict = {}
3381
2550
# A list of attributes that can not be pickled
3383
exclude = {"bus", "changedstate", "secret",
3384
"checker", "server_settings"}
3385
for name, typ in inspect.getmembers(dbus.service
2552
exclude = set(("bus", "changedstate", "secret",
2554
for name, typ in (inspect.getmembers
2555
(dbus.service.Object)):
3387
2556
exclude.add(name)
3389
2558
client_dict["encrypted_secret"] = (client
3390
2559
.encrypted_secret)
3391
2560
for attr in client.client_structure:
3392
2561
if attr not in exclude:
3393
2562
client_dict[attr] = getattr(client, attr)
3395
2564
clients[client.name] = client_dict
3396
2565
del client_settings[client.name]["secret"]
3399
with tempfile.NamedTemporaryFile(
3403
dir=os.path.dirname(stored_state_path),
3404
delete=False) as stored_state:
3405
pickle.dump((clients, client_settings), stored_state,
3407
tempname = stored_state.name
2568
with (tempfile.NamedTemporaryFile
2569
(mode='wb', suffix=".pickle", prefix='clients-',
2570
dir=os.path.dirname(stored_state_path),
2571
delete=False)) as stored_state:
2572
pickle.dump((clients, client_settings), stored_state)
2573
tempname=stored_state.name
3408
2574
os.rename(tempname, stored_state_path)
3409
2575
except (IOError, OSError) as e: