2
# -*- mode: python; coding: utf-8 -*-
2
# -*- coding: utf-8; lexical-binding: t -*-
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-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 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
14
# Copyright © 2008-2022 Teddy Hogeborn
15
# Copyright © 2008-2022 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
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
27
# GNU General Public License for more details.
27
29
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
31
32
# Contact the authors at <mandos@recompile.se>.
34
34
from __future__ import (division, absolute_import, print_function,
37
from future_builtins import *
38
from future_builtins import *
39
import SocketServer as socketserver
48
import SocketServer as socketserver
45
import gnutls.connection
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
55
import ConfigParser as configparser
59
63
import logging.handlers
65
import cPickle as pickle
70
import cPickle as pickle
66
73
import multiprocessing
74
84
import dbus.service
86
from gi.repository import GLib
77
87
from dbus.mainloop.glib import DBusGMainLoop
80
90
import xml.dom.minidom
93
if sys.version_info.major == 2:
98
# Add collections.abc.Callable if it does not exist
100
collections.abc.Callable
101
except AttributeError:
103
Callable = collections.Callable
104
collections.abc = abc
107
# Add shlex.quote if it does not exist
110
except AttributeError:
111
shlex.quote = re.escape
113
# Show warnings by default
114
if not sys.warnoptions:
116
warnings.simplefilter("default")
118
# Try to find the value of SO_BINDTODEVICE:
120
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
121
# newer, and it is also the most natural place for it:
84
122
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
123
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
87
127
from IN import SO_BINDTODEVICE
88
128
except ImportError:
89
SO_BINDTODEVICE = None
91
if sys.version_info.major == 2:
129
# In Python 2.7 it seems to have been removed entirely.
130
# Try running the C preprocessor:
132
cc = subprocess.Popen(["cc", "--language=c", "-E",
134
stdin=subprocess.PIPE,
135
stdout=subprocess.PIPE)
136
stdout = cc.communicate(
137
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
138
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
139
except (OSError, ValueError, IndexError):
141
SO_BINDTODEVICE = None
143
if sys.version_info < (3, 2):
144
configparser.Configparser = configparser.SafeConfigParser
95
147
stored_state_file = "clients.pickle"
97
logger = logging.getLogger()
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
150
logging.captureWarnings(True) # Show warnings via the logging system
101
if_nametoindex = (ctypes.cdll.LoadLibrary
102
(ctypes.util.find_library("c"))
154
if_nametoindex = ctypes.cdll.LoadLibrary(
155
ctypes.util.find_library("c")).if_nametoindex
104
156
except (OSError, AttributeError):
105
158
def if_nametoindex(interface):
106
159
"Get an interface index the hard way, i.e. using fcntl()"
107
160
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
183
265
.replace(b"\n", b"\\n")
184
266
.replace(b"\0", b"\\x00"))
187
269
def encrypt(self, data, password):
188
270
passphrase = self.password_encode(password)
189
with tempfile.NamedTemporaryFile(dir=self.tempdir
271
with tempfile.NamedTemporaryFile(
272
dir=self.tempdir) as passfile:
191
273
passfile.write(passphrase)
193
proc = subprocess.Popen(['gpg', '--symmetric',
275
proc = subprocess.Popen([self.gpg, "--symmetric",
196
278
+ self.gnupgargs,
197
stdin = subprocess.PIPE,
198
stdout = subprocess.PIPE,
199
stderr = subprocess.PIPE)
200
ciphertext, err = proc.communicate(input = data)
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
201
283
if proc.returncode != 0:
202
284
raise PGPError(err)
203
285
return ciphertext
205
287
def decrypt(self, data, password):
206
288
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(dir = self.tempdir
289
with tempfile.NamedTemporaryFile(
290
dir=self.tempdir) as passfile:
209
291
passfile.write(passphrase)
211
proc = subprocess.Popen(['gpg', '--decrypt',
293
proc = subprocess.Popen([self.gpg, "--decrypt",
214
296
+ self.gnupgargs,
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
decrypted_plaintext, err = proc.communicate(input
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
220
301
if proc.returncode != 0:
221
302
raise PGPError(err)
222
303
return decrypted_plaintext
306
# Pretend that we have an Avahi module
308
"""This isn't so much a class as it is a module-like namespace."""
309
IF_UNSPEC = -1 # avahi-common/address.h
310
PROTO_UNSPEC = -1 # avahi-common/address.h
311
PROTO_INET = 0 # avahi-common/address.h
312
PROTO_INET6 = 1 # avahi-common/address.h
313
DBUS_NAME = "org.freedesktop.Avahi"
314
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
315
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
DBUS_PATH_SERVER = "/"
319
def string_array_to_txt_array(t):
320
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
for s in t), signature="ay")
322
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
323
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
324
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
325
SERVER_INVALID = 0 # avahi-common/defs.h
326
SERVER_REGISTERING = 1 # avahi-common/defs.h
327
SERVER_RUNNING = 2 # avahi-common/defs.h
328
SERVER_COLLISION = 3 # avahi-common/defs.h
329
SERVER_FAILURE = 4 # avahi-common/defs.h
225
332
class AvahiError(Exception):
226
333
def __init__(self, value, *args, **kwargs):
227
334
self.value = value
228
335
return super(AvahiError, self).__init__(value, *args,
231
339
class AvahiServiceError(AvahiError):
234
343
class AvahiGroupError(AvahiError):
238
class AvahiService(object):
239
348
"""An Avahi (Zeroconf) service.
242
351
interface: integer; avahi.IF_UNSPEC or an interface index.
243
352
Used to optionally bind to the specified interface.
244
name: string; Example: 'Mandos'
245
type: string; Example: '_mandos._tcp'.
353
name: string; Example: "Mandos"
354
type: string; Example: "_mandos._tcp".
246
355
See <https://www.iana.org/assignments/service-names-port-numbers>
247
356
port: integer; what port to announce
248
357
TXT: list of strings; TXT record for the service
386
516
follow_name_owner_changes=True),
387
517
avahi.DBUS_INTERFACE_SERVER)
388
518
self.server.connect_to_signal("StateChanged",
389
self.server_state_changed)
519
self.server_state_changed)
390
520
self.server_state_changed(self.server.GetState())
393
523
class AvahiServiceToSyslog(AvahiService):
524
def rename(self, *args, **kwargs):
395
525
"""Add the new name to the syslog messages"""
396
ret = AvahiService.rename(self)
397
syslogger.setFormatter(logging.Formatter
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
526
ret = super(AvahiServiceToSyslog, self).rename(*args,
528
syslogger.setFormatter(logging.Formatter(
529
"Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
404
class Client(object):
534
# Pretend that we have a GnuTLS module
536
"""This isn't so much a class as it is a module-like namespace."""
538
library = ctypes.util.find_library("gnutls")
540
library = ctypes.util.find_library("gnutls-deb0")
541
_library = ctypes.cdll.LoadLibrary(library)
544
# Unless otherwise indicated, the constants and types below are
545
# all from the gnutls/gnutls.h C header file.
556
E_NO_CERTIFICATE_FOUND = -49
561
KEYID_USE_SHA256 = 1 # gnutls/x509.h
562
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
565
class _session_int(ctypes.Structure):
567
session_t = ctypes.POINTER(_session_int)
569
class certificate_credentials_st(ctypes.Structure):
571
certificate_credentials_t = ctypes.POINTER(
572
certificate_credentials_st)
573
certificate_type_t = ctypes.c_int
575
class datum_t(ctypes.Structure):
576
_fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
("size", ctypes.c_uint)]
579
class _openpgp_crt_int(ctypes.Structure):
581
openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
582
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
583
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
credentials_type_t = ctypes.c_int
585
transport_ptr_t = ctypes.c_void_p
586
close_request_t = ctypes.c_int
589
class Error(Exception):
590
def __init__(self, message=None, code=None, args=()):
591
# Default usage is by a message string, but if a return
592
# code is passed, convert it to a string with
595
if message is None and code is not None:
596
message = gnutls.strerror(code).decode(
597
"utf-8", errors="replace")
598
return super(gnutls.Error, self).__init__(
601
class CertificateSecurityError(Error):
605
def __init__(self, cls):
608
def from_param(self, obj):
609
if not isinstance(obj, self.cls):
610
raise TypeError("Not of type {}: {!r}"
611
.format(self.cls.__name__, obj))
612
return ctypes.byref(obj.from_param(obj))
614
class CastToVoidPointer:
615
def __init__(self, cls):
618
def from_param(self, obj):
619
if not isinstance(obj, self.cls):
620
raise TypeError("Not of type {}: {!r}"
621
.format(self.cls.__name__, obj))
622
return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
624
class With_from_param:
626
def from_param(cls, obj):
627
return obj._as_parameter_
630
class Credentials(With_from_param):
632
self._as_parameter_ = gnutls.certificate_credentials_t()
633
gnutls.certificate_allocate_credentials(self)
634
self.type = gnutls.CRD_CERTIFICATE
637
gnutls.certificate_free_credentials(self)
639
class ClientSession(With_from_param):
640
def __init__(self, socket, credentials=None):
641
self._as_parameter_ = gnutls.session_t()
642
gnutls_flags = gnutls.CLIENT
643
if gnutls.check_version(b"3.5.6"):
644
gnutls_flags |= gnutls.NO_TICKETS
646
gnutls_flags |= gnutls.ENABLE_RAWPK
647
gnutls.init(self, gnutls_flags)
649
gnutls.set_default_priority(self)
650
gnutls.transport_set_ptr(self, socket.fileno())
651
gnutls.handshake_set_private_extensions(self, True)
653
if credentials is None:
654
credentials = gnutls.Credentials()
655
gnutls.credentials_set(self, credentials.type,
657
self.credentials = credentials
663
return gnutls.handshake(self)
665
def send(self, data):
669
data_len -= gnutls.record_send(self, data[-data_len:],
673
return gnutls.bye(self, gnutls.SHUT_RDWR)
675
# Error handling functions
676
def _error_code(result):
677
"""A function to raise exceptions on errors, suitable
678
for the "restype" attribute on ctypes functions"""
679
if result >= gnutls.E_SUCCESS:
681
if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
raise gnutls.CertificateSecurityError(code=result)
683
raise gnutls.Error(code=result)
685
def _retry_on_error(result, func, arguments,
686
_error_code=_error_code):
687
"""A function to retry on some errors, suitable
688
for the "errcheck" attribute on ctypes functions"""
689
while result < gnutls.E_SUCCESS:
690
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
return _error_code(result)
692
result = func(*arguments)
695
# Unless otherwise indicated, the function declarations below are
696
# all from the gnutls/gnutls.h C header file.
699
priority_set_direct = _library.gnutls_priority_set_direct
700
priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
701
ctypes.POINTER(ctypes.c_char_p)]
702
priority_set_direct.restype = _error_code
704
init = _library.gnutls_init
705
init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
706
init.restype = _error_code
708
set_default_priority = _library.gnutls_set_default_priority
709
set_default_priority.argtypes = [ClientSession]
710
set_default_priority.restype = _error_code
712
record_send = _library.gnutls_record_send
713
record_send.argtypes = [ClientSession, ctypes.c_void_p,
715
record_send.restype = ctypes.c_ssize_t
716
record_send.errcheck = _retry_on_error
718
certificate_allocate_credentials = (
719
_library.gnutls_certificate_allocate_credentials)
720
certificate_allocate_credentials.argtypes = [
721
PointerTo(Credentials)]
722
certificate_allocate_credentials.restype = _error_code
724
certificate_free_credentials = (
725
_library.gnutls_certificate_free_credentials)
726
certificate_free_credentials.argtypes = [Credentials]
727
certificate_free_credentials.restype = None
729
handshake_set_private_extensions = (
730
_library.gnutls_handshake_set_private_extensions)
731
handshake_set_private_extensions.argtypes = [ClientSession,
733
handshake_set_private_extensions.restype = None
735
credentials_set = _library.gnutls_credentials_set
736
credentials_set.argtypes = [ClientSession, credentials_type_t,
737
CastToVoidPointer(Credentials)]
738
credentials_set.restype = _error_code
740
strerror = _library.gnutls_strerror
741
strerror.argtypes = [ctypes.c_int]
742
strerror.restype = ctypes.c_char_p
744
certificate_type_get = _library.gnutls_certificate_type_get
745
certificate_type_get.argtypes = [ClientSession]
746
certificate_type_get.restype = _error_code
748
certificate_get_peers = _library.gnutls_certificate_get_peers
749
certificate_get_peers.argtypes = [ClientSession,
750
ctypes.POINTER(ctypes.c_uint)]
751
certificate_get_peers.restype = ctypes.POINTER(datum_t)
753
global_set_log_level = _library.gnutls_global_set_log_level
754
global_set_log_level.argtypes = [ctypes.c_int]
755
global_set_log_level.restype = None
757
global_set_log_function = _library.gnutls_global_set_log_function
758
global_set_log_function.argtypes = [log_func]
759
global_set_log_function.restype = None
761
deinit = _library.gnutls_deinit
762
deinit.argtypes = [ClientSession]
763
deinit.restype = None
765
handshake = _library.gnutls_handshake
766
handshake.argtypes = [ClientSession]
767
handshake.restype = ctypes.c_int
768
handshake.errcheck = _retry_on_error
770
transport_set_ptr = _library.gnutls_transport_set_ptr
771
transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
772
transport_set_ptr.restype = None
774
bye = _library.gnutls_bye
775
bye.argtypes = [ClientSession, close_request_t]
776
bye.restype = ctypes.c_int
777
bye.errcheck = _retry_on_error
779
check_version = _library.gnutls_check_version
780
check_version.argtypes = [ctypes.c_char_p]
781
check_version.restype = ctypes.c_char_p
783
_need_version = b"3.3.0"
784
if check_version(_need_version) is None:
785
raise self.Error("Needs GnuTLS {} or later"
786
.format(_need_version))
788
_tls_rawpk_version = b"3.6.6"
789
has_rawpk = bool(check_version(_tls_rawpk_version))
793
class pubkey_st(ctypes.Structure):
795
pubkey_t = ctypes.POINTER(pubkey_st)
797
x509_crt_fmt_t = ctypes.c_int
799
# All the function declarations below are from
801
pubkey_init = _library.gnutls_pubkey_init
802
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
pubkey_init.restype = _error_code
805
pubkey_import = _library.gnutls_pubkey_import
806
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
808
pubkey_import.restype = _error_code
810
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
811
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
812
ctypes.POINTER(ctypes.c_ubyte),
813
ctypes.POINTER(ctypes.c_size_t)]
814
pubkey_get_key_id.restype = _error_code
816
pubkey_deinit = _library.gnutls_pubkey_deinit
817
pubkey_deinit.argtypes = [pubkey_t]
818
pubkey_deinit.restype = None
820
# All the function declarations below are from
823
openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
825
openpgp_crt_init.restype = _error_code
827
openpgp_crt_import = _library.gnutls_openpgp_crt_import
828
openpgp_crt_import.argtypes = [openpgp_crt_t,
829
ctypes.POINTER(datum_t),
831
openpgp_crt_import.restype = _error_code
833
openpgp_crt_verify_self = \
834
_library.gnutls_openpgp_crt_verify_self
835
openpgp_crt_verify_self.argtypes = [
838
ctypes.POINTER(ctypes.c_uint),
840
openpgp_crt_verify_self.restype = _error_code
842
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
843
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
844
openpgp_crt_deinit.restype = None
846
openpgp_crt_get_fingerprint = (
847
_library.gnutls_openpgp_crt_get_fingerprint)
848
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
852
openpgp_crt_get_fingerprint.restype = _error_code
854
if check_version(b"3.6.4"):
855
certificate_type_get2 = _library.gnutls_certificate_type_get2
856
certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
857
certificate_type_get2.restype = _error_code
859
# Remove non-public functions
860
del _error_code, _retry_on_error
863
def call_pipe(connection, # : multiprocessing.Connection
864
func, *args, **kwargs):
865
"""This function is meant to be called by multiprocessing.Process
867
This function runs func(*args, **kwargs), and writes the resulting
868
return value on the provided multiprocessing.Connection.
870
connection.send(func(*args, **kwargs))
405
875
"""A representation of a client host served by this server.
408
approved: bool(); 'None' if not yet approved/disapproved
878
approved: bool(); None if not yet approved/disapproved
409
879
approval_delay: datetime.timedelta(); Time to wait for approval
410
880
approval_duration: datetime.timedelta(); Duration of one approval
411
checker: subprocess.Popen(); a running checker process used
412
to see if the client lives.
413
'None' if no process is running.
414
checker_callback_tag: a gobject event source tag, or None
881
checker: multiprocessing.Process(); a running checker process used
882
to see if the client lives. None if no process is
884
checker_callback_tag: a GLib event source tag, or None
415
885
checker_command: string; External command which is run to check
416
886
if client lives. %() expansions are done at
417
887
runtime with vars(self) as dict, so that for
418
888
instance %(name)s can be used in the command.
419
checker_initiator_tag: a gobject event source tag, or None
889
checker_initiator_tag: a GLib event source tag, or None
420
890
created: datetime.datetime(); (UTC) object creation
421
891
client_structure: Object describing what attributes a client has
422
892
and is used for storing the client at exit
423
893
current_checker_command: string; current running checker_command
424
disable_initiator_tag: a gobject event source tag, or None
894
disable_initiator_tag: a GLib event source tag, or None
426
896
fingerprint: string (40 or 32 hexadecimal digits); used to
427
uniquely identify the client
897
uniquely identify an OpenPGP client
898
key_id: string (64 hexadecimal digits); used to uniquely identify
899
a client using raw public keys
428
900
host: string; available for use by the checker command
429
901
interval: datetime.timedelta(); How often to start a new checker
430
902
last_approval_request: datetime.datetime(); (UTC) or None
543
1029
self.current_checker_command = None
544
1030
self.approved = None
545
1031
self.approvals_pending = 0
546
self.changedstate = (multiprocessing_manager
547
.Condition(multiprocessing_manager
549
self.client_structure = [attr for attr in
550
self.__dict__.iterkeys()
1032
self.changedstate = multiprocessing_manager.Condition(
1033
multiprocessing_manager.Lock())
1034
self.client_structure = [attr
1035
for attr in self.__dict__.keys()
551
1036
if not attr.startswith("_")]
552
1037
self.client_structure.append("client_structure")
554
for name, t in inspect.getmembers(type(self),
1039
for name, t in inspect.getmembers(
1040
type(self), lambda obj: isinstance(obj, property)):
558
1041
if not name.startswith("_"):
559
1042
self.client_structure.append(name)
561
1044
# Send notice to process children that client state has changed
562
1045
def send_changedstate(self):
563
1046
with self.changedstate:
564
1047
self.changedstate.notify_all()
566
1049
def enable(self):
567
1050
"""Start this client's checker and timeout hooks"""
568
1051
if getattr(self, "enabled", False):
569
1052
# Already enabled
571
self.expires = datetime.datetime.utcnow() + self.timeout
572
1054
self.enabled = True
573
1055
self.last_enabled = datetime.datetime.utcnow()
574
1056
self.init_checker()
575
1057
self.send_changedstate()
577
1059
def disable(self, quiet=True):
578
1060
"""Disable this client."""
579
1061
if not getattr(self, "enabled", False):
582
logger.info("Disabling client %s", self.name)
1064
log.info("Disabling client %s", self.name)
583
1065
if getattr(self, "disable_initiator_tag", None) is not None:
584
gobject.source_remove(self.disable_initiator_tag)
1066
GLib.source_remove(self.disable_initiator_tag)
585
1067
self.disable_initiator_tag = None
586
1068
self.expires = None
587
1069
if getattr(self, "checker_initiator_tag", None) is not None:
588
gobject.source_remove(self.checker_initiator_tag)
1070
GLib.source_remove(self.checker_initiator_tag)
589
1071
self.checker_initiator_tag = None
590
1072
self.stop_checker()
591
1073
self.enabled = False
593
1075
self.send_changedstate()
594
# Do not run this again if called by a gobject.timeout_add
1076
# Do not run this again if called by a GLib.timeout_add
597
1079
def __del__(self):
600
def init_checker(self):
601
# Schedule a new checker to be started an 'interval' from now,
602
# and every interval from then on.
1082
def init_checker(self, randomize_start=False):
1083
# Schedule a new checker to be started a randomly selected
1084
# time (a fraction of 'interval') from now. This spreads out
1085
# the startup of checkers over time when the server is
603
1087
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
605
self.checker_initiator_tag = (gobject.timeout_add
607
.total_seconds() * 1000),
609
# Schedule a disable() when 'timeout' has passed
1088
GLib.source_remove(self.checker_initiator_tag)
1089
interval_milliseconds = int(self.interval.total_seconds()
1092
delay_milliseconds = random.randrange(
1093
interval_milliseconds + 1)
1095
delay_milliseconds = interval_milliseconds
1096
self.checker_initiator_tag = GLib.timeout_add(
1097
delay_milliseconds, self.start_checker, randomize_start)
1098
delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1099
# A checker might take up to an 'interval' of time, so we can
1100
# expire at the soonest one interval after a checker was
1101
# started. Since the initial checker is delayed, the expire
1102
# time might have to be extended.
1103
now = datetime.datetime.utcnow()
1104
self.expires = now + delay + self.interval
1105
# Schedule a disable() at expire time
610
1106
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
612
self.disable_initiator_tag = (gobject.timeout_add
614
.total_seconds() * 1000),
616
# Also start a new checker *right now*.
619
def checker_callback(self, pid, condition, command):
1107
GLib.source_remove(self.disable_initiator_tag)
1108
self.disable_initiator_tag = GLib.timeout_add(
1109
int((self.expires - now).total_seconds() * 1000),
1112
def checker_callback(self, source, condition, connection,
620
1114
"""The checker has completed, so take appropriate actions."""
1115
# Read return code from connection (see call_pipe)
1116
returncode = connection.recv()
1118
if self.checker is not None:
621
1120
self.checker_callback_tag = None
622
1121
self.checker = None
623
if os.WIFEXITED(condition):
624
self.last_checker_status = os.WEXITSTATUS(condition)
1124
self.last_checker_status = returncode
1125
self.last_checker_signal = None
625
1126
if self.last_checker_status == 0:
626
logger.info("Checker for %(name)s succeeded",
1127
log.info("Checker for %(name)s succeeded", vars(self))
628
1128
self.checked_ok()
630
logger.info("Checker for %(name)s failed",
1130
log.info("Checker for %(name)s failed", vars(self))
633
1132
self.last_checker_status = -1
634
logger.warning("Checker for %(name)s crashed?",
1133
self.last_checker_signal = -returncode
1134
log.warning("Checker for %(name)s crashed?", vars(self))
637
1137
def checked_ok(self):
638
1138
"""Assert that the client has been seen, alive and well."""
639
1139
self.last_checked_ok = datetime.datetime.utcnow()
640
1140
self.last_checker_status = 0
1141
self.last_checker_signal = None
641
1142
self.bump_timeout()
643
1144
def bump_timeout(self, timeout=None):
644
1145
"""Bump up the timeout for this client."""
645
1146
if timeout is None:
646
1147
timeout = self.timeout
647
1148
if self.disable_initiator_tag is not None:
648
gobject.source_remove(self.disable_initiator_tag)
1149
GLib.source_remove(self.disable_initiator_tag)
649
1150
self.disable_initiator_tag = None
650
1151
if getattr(self, "enabled", False):
651
self.disable_initiator_tag = (gobject.timeout_add
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
1152
self.disable_initiator_tag = GLib.timeout_add(
1153
int(timeout.total_seconds() * 1000), self.disable)
654
1154
self.expires = datetime.datetime.utcnow() + timeout
656
1156
def need_approval(self):
657
1157
self.last_approval_request = datetime.datetime.utcnow()
659
def start_checker(self):
1159
def start_checker(self, start_was_randomized=False):
660
1160
"""Start a new checker subprocess if one is not running.
662
1162
If a checker already exists, leave it running and do
664
1164
# The reason for not killing a running checker is that if we
669
1169
# checkers alone, the checker would have to take more time
670
1170
# than 'timeout' for the client to be disabled, which is as it
673
# If a checker exists, make sure it is not a zombie
675
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
676
except AttributeError:
678
except OSError as error:
679
if error.errno != errno.ECHILD:
683
logger.warning("Checker was a zombie")
684
gobject.source_remove(self.checker_callback_tag)
685
self.checker_callback(pid, status,
686
self.current_checker_command)
1173
if self.checker is not None and not self.checker.is_alive():
1174
log.warning("Checker was not alive; joining")
687
1177
# Start a new checker if needed
688
1178
if self.checker is None:
689
1179
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(str(getattr(self, attr)))
692
for attr in self.runtime_expansions }
1181
attr: shlex.quote(str(getattr(self, attr)))
1182
for attr in self.runtime_expansions}
694
1184
command = self.checker_command % escaped_attrs
695
1185
except TypeError as error:
696
logger.error('Could not format string "%s"',
697
self.checker_command, exc_info=error)
698
return True # Try again later
1186
log.error('Could not format string "%s"',
1187
self.checker_command, exc_info=error)
1188
return True # Try again later
699
1189
self.current_checker_command = command
701
logger.info("Starting checker %r for %s",
703
# We don't need to redirect stdout and stderr, since
704
# in normal mode, that is already done by daemon(),
705
# and in debug mode we don't want to. (Stdin is
706
# always replaced by /dev/null.)
707
# The exception is when not debugging but nevertheless
708
# running in the foreground; use the previously
711
if (not self.server_settings["debug"]
712
and self.server_settings["foreground"]):
713
popen_args.update({"stdout": wnull,
715
self.checker = subprocess.Popen(command,
719
except OSError as error:
720
logger.error("Failed to start subprocess",
723
self.checker_callback_tag = (gobject.child_watch_add
725
self.checker_callback,
727
# The checker may have completed before the gobject
728
# watch was added. Check for this.
730
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
731
except OSError as error:
732
if error.errno == errno.ECHILD:
733
# This should never happen
734
logger.error("Child process vanished",
739
gobject.source_remove(self.checker_callback_tag)
740
self.checker_callback(pid, status, command)
741
# Re-run this periodically if run by gobject.timeout_add
1190
log.info("Starting checker %r for %s", command, self.name)
1191
# We don't need to redirect stdout and stderr, since
1192
# in normal mode, that is already done by daemon(),
1193
# and in debug mode we don't want to. (Stdin is
1194
# always replaced by /dev/null.)
1195
# The exception is when not debugging but nevertheless
1196
# running in the foreground; use the previously
1198
popen_args = {"close_fds": True,
1201
if (not self.server_settings["debug"]
1202
and self.server_settings["foreground"]):
1203
popen_args.update({"stdout": wnull,
1205
pipe = multiprocessing.Pipe(duplex=False)
1206
self.checker = multiprocessing.Process(
1208
args=(pipe[1], subprocess.call, command),
1210
self.checker.start()
1211
self.checker_callback_tag = GLib.io_add_watch(
1212
GLib.IOChannel.unix_new(pipe[0].fileno()),
1213
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1214
self.checker_callback, pipe[0], command)
1215
if start_was_randomized:
1216
# We were started after a random delay; Schedule a new
1217
# checker to be started an 'interval' from now, and every
1218
# interval from then on.
1219
now = datetime.datetime.utcnow()
1220
self.checker_initiator_tag = GLib.timeout_add(
1221
int(self.interval.total_seconds() * 1000),
1223
self.expires = max(self.expires, now + self.interval)
1224
# Don't start a new checker again after same random delay
1226
# Re-run this periodically if run by GLib.timeout_add
744
1229
def stop_checker(self):
745
1230
"""Force the checker process, if any, to stop."""
746
1231
if self.checker_callback_tag:
747
gobject.source_remove(self.checker_callback_tag)
1232
GLib.source_remove(self.checker_callback_tag)
748
1233
self.checker_callback_tag = None
749
1234
if getattr(self, "checker", None) is None:
751
logger.debug("Stopping checker for %(name)s", vars(self))
753
self.checker.terminate()
755
#if self.checker.poll() is None:
756
# self.checker.kill()
757
except OSError as error:
758
if error.errno != errno.ESRCH: # No such process
1236
log.debug("Stopping checker for %(name)s", vars(self))
1237
self.checker.terminate()
760
1238
self.checker = None
763
def dbus_service_property(dbus_interface, signature="v",
764
access="readwrite", byte_arrays=False):
1241
def dbus_service_property(dbus_interface,
765
1245
"""Decorators for marking methods of a DBusObjectWithProperties to
766
1246
become properties on the D-Bus.
768
1248
The decorated method will be called with no arguments by "Get"
769
1249
and with one argument by "Set".
771
1251
The parameters, where they are supported, are the same as
772
1252
dbus.service.method, except there is only "signature", since the
773
1253
type from Get() and the type sent to Set() is the same.
847
class DBusObjectWithProperties(dbus.service.Object):
848
"""A D-Bus object with properties.
850
Classes inheriting from this can use the dbus_service_property
851
decorator to expose methods as D-Bus properties. It exposes the
852
standard Get(), Set(), and GetAll() methods on the D-Bus.
1336
class DBusObjectWithAnnotations(dbus.service.Object):
1337
"""A D-Bus object with annotations.
1339
Classes inheriting from this can use the dbus_annotations
1340
decorator to add annotations to methods or signals.
856
1344
def _is_dbus_thing(thing):
857
1345
"""Returns a function testing if an attribute is a D-Bus thing
859
1347
If called like _is_dbus_thing("method") it returns a function
860
1348
suitable for use as predicate to inspect.getmembers().
862
1350
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
865
1353
def _get_all_dbus_things(self, thing):
866
1354
"""Returns a generator of (name, attribute) pairs
868
return ((getattr(athing.__get__(self), "_dbus_name",
1356
return ((getattr(athing.__get__(self), "_dbus_name", name),
870
1357
athing.__get__(self))
871
1358
for cls in self.__class__.__mro__
872
1359
for name, athing in
873
inspect.getmembers(cls,
874
self._is_dbus_thing(thing)))
1360
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1362
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1364
path_keyword="object_path",
1365
connection_keyword="connection")
1366
def Introspect(self, object_path, connection):
1367
"""Overloading of standard D-Bus method.
1369
Inserts annotation tags on methods and signals.
1371
xmlstring = dbus.service.Object.Introspect(self, object_path,
1374
document = xml.dom.minidom.parseString(xmlstring)
1376
for if_tag in document.getElementsByTagName("interface"):
1377
# Add annotation tags
1378
for typ in ("method", "signal"):
1379
for tag in if_tag.getElementsByTagName(typ):
1381
for name, prop in (self.
1382
_get_all_dbus_things(typ)):
1383
if (name == tag.getAttribute("name")
1384
and prop._dbus_interface
1385
== if_tag.getAttribute("name")):
1386
annots.update(getattr(
1387
prop, "_dbus_annotations", {}))
1388
for name, value in annots.items():
1389
ann_tag = document.createElement(
1391
ann_tag.setAttribute("name", name)
1392
ann_tag.setAttribute("value", value)
1393
tag.appendChild(ann_tag)
1394
# Add interface annotation tags
1395
for annotation, value in dict(
1396
itertools.chain.from_iterable(
1397
annotations().items()
1398
for name, annotations
1399
in self._get_all_dbus_things("interface")
1400
if name == if_tag.getAttribute("name")
1402
ann_tag = document.createElement("annotation")
1403
ann_tag.setAttribute("name", annotation)
1404
ann_tag.setAttribute("value", value)
1405
if_tag.appendChild(ann_tag)
1406
# Fix argument name for the Introspect method itself
1407
if (if_tag.getAttribute("name")
1408
== dbus.INTROSPECTABLE_IFACE):
1409
for cn in if_tag.getElementsByTagName("method"):
1410
if cn.getAttribute("name") == "Introspect":
1411
for arg in cn.getElementsByTagName("arg"):
1412
if (arg.getAttribute("direction")
1414
arg.setAttribute("name",
1416
xmlstring = document.toxml("utf-8")
1418
except (AttributeError, xml.dom.DOMException,
1419
xml.parsers.expat.ExpatError) as error:
1420
log.error("Failed to override Introspection method",
1425
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1426
"""A D-Bus object with properties.
1428
Classes inheriting from this can use the dbus_service_property
1429
decorator to expose methods as D-Bus properties. It exposes the
1430
standard Get(), Set(), and GetAll() methods on the D-Bus.
876
1433
def _get_dbus_property(self, interface_name, property_name):
877
1434
"""Returns a bound method if one exists which is a D-Bus
878
1435
property with the specified name and interface.
880
for cls in self.__class__.__mro__:
881
for name, value in (inspect.getmembers
883
self._is_dbus_thing("property"))):
1437
for cls in self.__class__.__mro__:
1438
for name, value in inspect.getmembers(
1439
cls, self._is_dbus_thing("property")):
884
1440
if (value._dbus_name == property_name
885
1441
and value._dbus_interface == interface_name):
886
1442
return value.__get__(self)
888
1444
# No such property
889
raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
+ interface_name + "."
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1445
raise DBusPropertyNotFound("{}:{}.{}".format(
1446
self.dbus_object_path, interface_name, property_name))
1449
def _get_all_interface_names(cls):
1450
"""Get a sequence of all interfaces supported by an object"""
1451
return (name for name in set(getattr(getattr(x, attr),
1452
"_dbus_interface", None)
1453
for x in (inspect.getmro(cls))
1455
if name is not None)
1457
@dbus.service.method(dbus.PROPERTIES_IFACE,
894
1459
out_signature="v")
895
1460
def Get(self, interface_name, property_name):
896
1461
"""Standard D-Bus property Get() method, see D-Bus standard.
1031
1584
document.unlink()
1032
1585
except (AttributeError, xml.dom.DOMException,
1033
1586
xml.parsers.expat.ExpatError) as error:
1034
logger.error("Failed to override Introspection method",
1587
log.error("Failed to override Introspection method",
1593
dbus.OBJECT_MANAGER_IFACE
1594
except AttributeError:
1595
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1598
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1599
"""A D-Bus object with an ObjectManager.
1601
Classes inheriting from this exposes the standard
1602
GetManagedObjects call and the InterfacesAdded and
1603
InterfacesRemoved signals on the standard
1604
"org.freedesktop.DBus.ObjectManager" interface.
1606
Note: No signals are sent automatically; they must be sent
1609
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1610
out_signature="a{oa{sa{sv}}}")
1611
def GetManagedObjects(self):
1612
"""This function must be overridden"""
1613
raise NotImplementedError()
1615
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1616
signature="oa{sa{sv}}")
1617
def InterfacesAdded(self, object_path, interfaces_and_properties):
1620
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1621
def InterfacesRemoved(self, object_path, interfaces):
1624
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1626
path_keyword="object_path",
1627
connection_keyword="connection")
1628
def Introspect(self, object_path, connection):
1629
"""Overloading of standard D-Bus method.
1631
Override return argument name of GetManagedObjects to be
1632
"objpath_interfaces_and_properties"
1634
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1638
document = xml.dom.minidom.parseString(xmlstring)
1640
for if_tag in document.getElementsByTagName("interface"):
1641
# Fix argument name for the GetManagedObjects method
1642
if (if_tag.getAttribute("name")
1643
== dbus.OBJECT_MANAGER_IFACE):
1644
for cn in if_tag.getElementsByTagName("method"):
1645
if (cn.getAttribute("name")
1646
== "GetManagedObjects"):
1647
for arg in cn.getElementsByTagName("arg"):
1648
if (arg.getAttribute("direction")
1652
"objpath_interfaces"
1654
xmlstring = document.toxml("utf-8")
1656
except (AttributeError, xml.dom.DOMException,
1657
xml.parsers.expat.ExpatError) as error:
1658
log.error("Failed to override Introspection method",
1036
1660
return xmlstring
1039
1663
def datetime_to_dbus(dt, variant_level=0):
1040
1664
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1042
return dbus.String("", variant_level = variant_level)
1043
return dbus.String(dt.isoformat(),
1044
variant_level=variant_level)
1666
return dbus.String("", variant_level=variant_level)
1667
return dbus.String(dt.isoformat(), variant_level=variant_level)
1047
1670
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1407
2031
server to mandos-client
1411
2035
# Rejected - signal
1412
2036
@dbus.service.signal(_interface, signature="s")
1413
2037
def Rejected(self, reason):
1417
2041
# NeedApproval - signal
1418
2042
@dbus.service.signal(_interface, signature="tb")
1419
2043
def NeedApproval(self, timeout, default):
1421
2045
return self.need_approval()
1425
2049
# Approve - method
1426
2050
@dbus.service.method(_interface, in_signature="b")
1427
2051
def Approve(self, value):
1428
2052
self.approve(value)
1430
2054
# CheckedOK - method
1431
2055
@dbus.service.method(_interface)
1432
2056
def CheckedOK(self):
1433
2057
self.checked_ok()
1435
2059
# Enable - method
2060
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1436
2061
@dbus.service.method(_interface)
1437
2062
def Enable(self):
1441
2066
# StartChecker - method
2067
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1442
2068
@dbus.service.method(_interface)
1443
2069
def StartChecker(self):
1445
2071
self.start_checker()
1447
2073
# Disable - method
2074
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1448
2075
@dbus.service.method(_interface)
1449
2076
def Disable(self):
1453
2080
# StopChecker - method
2081
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1454
2082
@dbus.service.method(_interface)
1455
2083
def StopChecker(self):
1456
2084
self.stop_checker()
1460
2088
# ApprovalPending - property
1461
2089
@dbus_service_property(_interface, signature="b", access="read")
1462
2090
def ApprovalPending_dbus_property(self):
1463
2091
return dbus.Boolean(bool(self.approvals_pending))
1465
2093
# ApprovedByDefault - property
1466
@dbus_service_property(_interface, signature="b",
2094
@dbus_service_property(_interface,
1467
2096
access="readwrite")
1468
2097
def ApprovedByDefault_dbus_property(self, value=None):
1469
2098
if value is None: # get
1470
2099
return dbus.Boolean(self.approved_by_default)
1471
2100
self.approved_by_default = bool(value)
1473
2102
# ApprovalDelay - property
1474
@dbus_service_property(_interface, signature="t",
2103
@dbus_service_property(_interface,
1475
2105
access="readwrite")
1476
2106
def ApprovalDelay_dbus_property(self, value=None):
1477
2107
if value is None: # get
1478
2108
return dbus.UInt64(self.approval_delay.total_seconds()
1480
2110
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1482
2112
# ApprovalDuration - property
1483
@dbus_service_property(_interface, signature="t",
2113
@dbus_service_property(_interface,
1484
2115
access="readwrite")
1485
2116
def ApprovalDuration_dbus_property(self, value=None):
1486
2117
if value is None: # get
1487
2118
return dbus.UInt64(self.approval_duration.total_seconds()
1489
2120
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1491
2122
# Name - property
2124
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1492
2125
@dbus_service_property(_interface, signature="s", access="read")
1493
2126
def Name_dbus_property(self):
1494
2127
return dbus.String(self.name)
2131
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2132
@dbus_service_property(_interface, signature="s", access="read")
2133
def KeyID_dbus_property(self):
2134
return dbus.String(self.key_id)
1496
2136
# Fingerprint - property
2138
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1497
2139
@dbus_service_property(_interface, signature="s", access="read")
1498
2140
def Fingerprint_dbus_property(self):
1499
2141
return dbus.String(self.fingerprint)
1501
2143
# Host - property
1502
@dbus_service_property(_interface, signature="s",
2144
@dbus_service_property(_interface,
1503
2146
access="readwrite")
1504
2147
def Host_dbus_property(self, value=None):
1505
2148
if value is None: # get
1506
2149
return dbus.String(self.host)
1507
2150
self.host = str(value)
1509
2152
# Created - property
2154
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1510
2155
@dbus_service_property(_interface, signature="s", access="read")
1511
2156
def Created_dbus_property(self):
1512
2157
return datetime_to_dbus(self.created)
1514
2159
# LastEnabled - property
1515
2160
@dbus_service_property(_interface, signature="s", access="read")
1516
2161
def LastEnabled_dbus_property(self):
1517
2162
return datetime_to_dbus(self.last_enabled)
1519
2164
# Enabled - property
1520
@dbus_service_property(_interface, signature="b",
2165
@dbus_service_property(_interface,
1521
2167
access="readwrite")
1522
2168
def Enabled_dbus_property(self, value=None):
1523
2169
if value is None: # get
1620
2270
self.start_checker()
1622
2272
self.stop_checker()
1624
2274
# ObjectPath - property
2276
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2277
"org.freedesktop.DBus.Deprecated": "true"})
1625
2278
@dbus_service_property(_interface, signature="o", access="read")
1626
2279
def ObjectPath_dbus_property(self):
1627
return self.dbus_object_path # is already a dbus.ObjectPath
2280
return self.dbus_object_path # is already a dbus.ObjectPath
1629
2282
# Secret = property
1630
@dbus_service_property(_interface, signature="ay",
1631
access="write", byte_arrays=True)
2284
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2286
@dbus_service_property(_interface,
1632
2290
def Secret_dbus_property(self, value):
1633
2291
self.secret = bytes(value)
1638
class ProxyClient(object):
1639
def __init__(self, child_pipe, fpr, address):
2297
def __init__(self, child_pipe, key_id, fpr, address):
1640
2298
self._pipe = child_pipe
1641
self._pipe.send(('init', fpr, address))
2299
self._pipe.send(("init", key_id, fpr, address))
1642
2300
if not self._pipe.recv():
2301
raise KeyError(key_id or fpr)
1645
2303
def __getattribute__(self, name):
1647
2305
return super(ProxyClient, self).__getattribute__(name)
1648
self._pipe.send(('getattr', name))
2306
self._pipe.send(("getattr", name))
1649
2307
data = self._pipe.recv()
1650
if data[0] == 'data':
2308
if data[0] == "data":
1652
if data[0] == 'function':
2310
if data[0] == "function":
1653
2312
def func(*args, **kwargs):
1654
self._pipe.send(('funcall', name, args, kwargs))
2313
self._pipe.send(("funcall", name, args, kwargs))
1655
2314
return self._pipe.recv()[1]
1658
2318
def __setattr__(self, name, value):
1660
2320
return super(ProxyClient, self).__setattr__(name, value)
1661
self._pipe.send(('setattr', name, value))
2321
self._pipe.send(("setattr", name, value))
1664
2324
class ClientHandler(socketserver.BaseRequestHandler, object):
1665
2325
"""A class to handle client connections.
1667
2327
Instantiated once for each connection to handle it.
1668
2328
Note: This will run in its own forked process."""
1670
2330
def handle(self):
1671
2331
with contextlib.closing(self.server.child_pipe) as child_pipe:
1672
logger.info("TCP connection from: %s",
1673
str(self.client_address))
1674
logger.debug("Pipe FD: %d",
1675
self.server.child_pipe.fileno())
1677
session = (gnutls.connection
1678
.ClientSession(self.request,
1680
.X509Credentials()))
1682
# Note: gnutls.connection.X509Credentials is really a
1683
# generic GnuTLS certificate credentials object so long as
1684
# no X.509 keys are added to it. Therefore, we can use it
1685
# here despite using OpenPGP certificates.
1687
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1688
# "+AES-256-CBC", "+SHA1",
1689
# "+COMP-NULL", "+CTYPE-OPENPGP",
2332
log.info("TCP connection from: %s",
2333
str(self.client_address))
2334
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2336
session = gnutls.ClientSession(self.request)
2338
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2339
# "+AES-256-CBC", "+SHA1",
2340
# "+COMP-NULL", "+CTYPE-OPENPGP",
1691
2342
# Use a fallback default, since this MUST be set.
1692
2343
priority = self.server.gnutls_priority
1693
2344
if priority is None:
1694
2345
priority = "NORMAL"
1695
(gnutls.library.functions
1696
.gnutls_priority_set_direct(session._c_object,
2346
gnutls.priority_set_direct(session,
2347
priority.encode("utf-8"), None)
1699
2349
# Start communication using the Mandos protocol
1700
2350
# Get protocol number
1701
2351
line = self.request.makefile().readline()
1702
logger.debug("Protocol version: %r", line)
2352
log.debug("Protocol version: %r", line)
1704
2354
if int(line.strip().split()[0]) > 1:
1705
2355
raise RuntimeError(line)
1706
2356
except (ValueError, IndexError, RuntimeError) as error:
1707
logger.error("Unknown protocol version: %s", error)
2357
log.error("Unknown protocol version: %s", error)
1710
2360
# Start GnuTLS connection
1712
2362
session.handshake()
1713
except gnutls.errors.GNUTLSError as error:
1714
logger.warning("Handshake failed: %s", error)
2363
except gnutls.Error as error:
2364
log.warning("Handshake failed: %s", error)
1715
2365
# Do not run session.bye() here: the session is not
1716
2366
# established. Just abandon the request.
1718
logger.debug("Handshake succeeded")
2368
log.debug("Handshake succeeded")
1720
2370
approval_required = False
1723
fpr = self.fingerprint(self.peer_certificate
1726
gnutls.errors.GNUTLSError) as error:
1727
logger.warning("Bad certificate: %s", error)
1729
logger.debug("Fingerprint: %s", fpr)
1732
client = ProxyClient(child_pipe, fpr,
2372
if gnutls.has_rawpk:
2375
key_id = self.key_id(
2376
self.peer_certificate(session))
2377
except (TypeError, gnutls.Error) as error:
2378
log.warning("Bad certificate: %s", error)
2380
log.debug("Key ID: %s",
2381
key_id.decode("utf-8",
2387
fpr = self.fingerprint(
2388
self.peer_certificate(session))
2389
except (TypeError, gnutls.Error) as error:
2390
log.warning("Bad certificate: %s", error)
2392
log.debug("Fingerprint: %s", fpr)
2395
client = ProxyClient(child_pipe, key_id, fpr,
1733
2396
self.client_address)
1734
2397
except KeyError:
1737
2400
if client.approval_delay:
1738
2401
delay = client.approval_delay
1739
2402
client.approvals_pending += 1
1740
2403
approval_required = True
1743
2406
if not client.enabled:
1744
logger.info("Client %s is disabled",
2407
log.info("Client %s is disabled", client.name)
1746
2408
if self.server.use_dbus:
1747
2409
# Emit D-Bus signal
1748
2410
client.Rejected("Disabled")
1751
2413
if client.approved or not client.approval_delay:
1752
#We are approved or approval is disabled
2414
# We are approved or approval is disabled
1754
2416
elif client.approved is None:
1755
logger.info("Client %s needs approval",
2417
log.info("Client %s needs approval",
1757
2419
if self.server.use_dbus:
1758
2420
# Emit D-Bus signal
1759
2421
client.NeedApproval(
1760
2422
client.approval_delay.total_seconds()
1761
2423
* 1000, client.approved_by_default)
1763
logger.warning("Client %s was not approved",
2425
log.warning("Client %s was not approved",
1765
2427
if self.server.use_dbus:
1766
2428
# Emit D-Bus signal
1767
2429
client.Rejected("Denied")
1770
#wait until timeout or approved
2432
# wait until timeout or approved
1771
2433
time = datetime.datetime.now()
1772
2434
client.changedstate.acquire()
1773
2435
client.changedstate.wait(delay.total_seconds())
1788
2450
delay -= time2 - time
1791
while sent_size < len(client.secret):
1793
sent = session.send(client.secret[sent_size:])
1794
except gnutls.errors.GNUTLSError as error:
1795
logger.warning("gnutls send failed",
1798
logger.debug("Sent: %d, remaining: %d",
1799
sent, len(client.secret)
1800
- (sent_size + sent))
1803
logger.info("Sending secret to %s", client.name)
2453
session.send(client.secret)
2454
except gnutls.Error as error:
2455
log.warning("gnutls send failed", exc_info=error)
2458
log.info("Sending secret to %s", client.name)
1804
2459
# bump the timeout using extended_timeout
1805
2460
client.bump_timeout(client.extended_timeout)
1806
2461
if self.server.use_dbus:
1807
2462
# Emit D-Bus signal
1808
2463
client.GotSecret()
1811
2466
if approval_required:
1812
2467
client.approvals_pending -= 1
1815
except gnutls.errors.GNUTLSError as error:
1816
logger.warning("GnuTLS bye failed",
2470
except gnutls.Error as error:
2471
log.warning("GnuTLS bye failed", exc_info=error)
1820
2474
def peer_certificate(session):
1821
"Return the peer's OpenPGP certificate as a bytestring"
1822
# If not an OpenPGP certificate...
1823
if (gnutls.library.functions
1824
.gnutls_certificate_type_get(session._c_object)
1825
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1826
# ...do the normal thing
1827
return session.peer_certificate
2475
"Return the peer's certificate as a bytestring"
2477
cert_type = gnutls.certificate_type_get2(
2478
session, gnutls.CTYPE_PEERS)
2479
except AttributeError:
2480
cert_type = gnutls.certificate_type_get(session)
2481
if gnutls.has_rawpk:
2482
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2484
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2485
# If not a valid certificate type...
2486
if cert_type not in valid_cert_types:
2487
log.info("Cert type %r not in %r", cert_type,
2489
# ...return invalid data
1828
2491
list_size = ctypes.c_uint(1)
1829
cert_list = (gnutls.library.functions
1830
.gnutls_certificate_get_peers
1831
(session._c_object, ctypes.byref(list_size)))
2492
cert_list = (gnutls.certificate_get_peers
2493
(session, ctypes.byref(list_size)))
1832
2494
if not bool(cert_list) and list_size.value != 0:
1833
raise gnutls.errors.GNUTLSError("error getting peer"
2495
raise gnutls.Error("error getting peer certificate")
1835
2496
if list_size.value == 0:
1837
2498
cert = cert_list[0]
1838
2499
return ctypes.string_at(cert.data, cert.size)
2502
def key_id(certificate):
2503
"Convert a certificate bytestring to a hexdigit key ID"
2504
# New GnuTLS "datum" with the public key
2505
datum = gnutls.datum_t(
2506
ctypes.cast(ctypes.c_char_p(certificate),
2507
ctypes.POINTER(ctypes.c_ubyte)),
2508
ctypes.c_uint(len(certificate)))
2509
# XXX all these need to be created in the gnutls "module"
2510
# New empty GnuTLS certificate
2511
pubkey = gnutls.pubkey_t()
2512
gnutls.pubkey_init(ctypes.byref(pubkey))
2513
# Import the raw public key into the certificate
2514
gnutls.pubkey_import(pubkey,
2515
ctypes.byref(datum),
2516
gnutls.X509_FMT_DER)
2517
# New buffer for the key ID
2518
buf = ctypes.create_string_buffer(32)
2519
buf_len = ctypes.c_size_t(len(buf))
2520
# Get the key ID from the raw public key into the buffer
2521
gnutls.pubkey_get_key_id(
2523
gnutls.KEYID_USE_SHA256,
2524
ctypes.cast(ctypes.byref(buf),
2525
ctypes.POINTER(ctypes.c_ubyte)),
2526
ctypes.byref(buf_len))
2527
# Deinit the certificate
2528
gnutls.pubkey_deinit(pubkey)
2530
# Convert the buffer to a Python bytestring
2531
key_id = ctypes.string_at(buf, buf_len.value)
2532
# Convert the bytestring to hexadecimal notation
2533
hex_key_id = binascii.hexlify(key_id).upper()
1841
2537
def fingerprint(openpgp):
1842
2538
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1843
2539
# New GnuTLS "datum" with the OpenPGP public key
1844
datum = (gnutls.library.types
1845
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1848
ctypes.c_uint(len(openpgp))))
2540
datum = gnutls.datum_t(
2541
ctypes.cast(ctypes.c_char_p(openpgp),
2542
ctypes.POINTER(ctypes.c_ubyte)),
2543
ctypes.c_uint(len(openpgp)))
1849
2544
# New empty GnuTLS certificate
1850
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1851
(gnutls.library.functions
1852
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2545
crt = gnutls.openpgp_crt_t()
2546
gnutls.openpgp_crt_init(ctypes.byref(crt))
1853
2547
# Import the OpenPGP public key into the certificate
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1856
gnutls.library.constants
1857
.GNUTLS_OPENPGP_FMT_RAW))
2548
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2549
gnutls.OPENPGP_FMT_RAW)
1858
2550
# Verify the self signature in the key
1859
2551
crtverify = ctypes.c_uint()
1860
(gnutls.library.functions
1861
.gnutls_openpgp_crt_verify_self(crt, 0,
1862
ctypes.byref(crtverify)))
2552
gnutls.openpgp_crt_verify_self(crt, 0,
2553
ctypes.byref(crtverify))
1863
2554
if crtverify.value != 0:
1864
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1865
raise (gnutls.errors.CertificateSecurityError
2555
gnutls.openpgp_crt_deinit(crt)
2556
raise gnutls.CertificateSecurityError(code
1867
2558
# New buffer for the fingerprint
1868
2559
buf = ctypes.create_string_buffer(20)
1869
2560
buf_len = ctypes.c_size_t()
1870
2561
# Get the fingerprint from the certificate into the buffer
1871
(gnutls.library.functions
1872
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1873
ctypes.byref(buf_len)))
2562
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2563
ctypes.byref(buf_len))
1874
2564
# Deinit the certificate
1875
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2565
gnutls.openpgp_crt_deinit(crt)
1876
2566
# Convert the buffer to a Python bytestring
1877
2567
fpr = ctypes.string_at(buf, buf_len.value)
1878
2568
# Convert the bytestring to hexadecimal notation
1961
2657
# socket_wrapper(), if socketfd was set.
1962
2658
socketserver.TCPServer.__init__(self, server_address,
1963
2659
RequestHandlerClass)
1965
2661
def server_bind(self):
1966
2662
"""This overrides the normal server_bind() function
1967
2663
to bind to an interface if one was specified, and also NOT to
1968
2664
bind to an address or port if they were not specified."""
2665
global SO_BINDTODEVICE
1969
2666
if self.interface is not None:
1970
2667
if SO_BINDTODEVICE is None:
1971
logger.error("SO_BINDTODEVICE does not exist;"
1972
" cannot bind to interface %s",
1976
self.socket.setsockopt(socket.SOL_SOCKET,
1978
(self.interface + "\0")
1980
except socket.error as error:
1981
if error.errno == errno.EPERM:
1982
logger.error("No permission to bind to"
1983
" interface %s", self.interface)
1984
elif error.errno == errno.ENOPROTOOPT:
1985
logger.error("SO_BINDTODEVICE not available;"
1986
" cannot bind to interface %s",
1988
elif error.errno == errno.ENODEV:
1989
logger.error("Interface %s does not exist,"
1990
" cannot bind", self.interface)
2668
# Fall back to a hard-coded value which seems to be
2670
log.warning("SO_BINDTODEVICE not found, trying 25")
2671
SO_BINDTODEVICE = 25
2673
self.socket.setsockopt(
2674
socket.SOL_SOCKET, SO_BINDTODEVICE,
2675
(self.interface + "\0").encode("utf-8"))
2676
except socket.error as error:
2677
if error.errno == errno.EPERM:
2678
log.error("No permission to bind to interface %s",
2680
elif error.errno == errno.ENOPROTOOPT:
2681
log.error("SO_BINDTODEVICE not available; cannot"
2682
" bind to interface %s", self.interface)
2683
elif error.errno == errno.ENODEV:
2684
log.error("Interface %s does not exist, cannot"
2685
" bind", self.interface)
1993
2688
# Only bind(2) the socket if we really need to.
1994
2689
if self.server_address[0] or self.server_address[1]:
2690
if self.server_address[1]:
2691
self.allow_reuse_address = True
1995
2692
if not self.server_address[0]:
1996
2693
if self.address_family == socket.AF_INET6:
1997
any_address = "::" # in6addr_any
2694
any_address = "::" # in6addr_any
1999
any_address = "0.0.0.0" # INADDR_ANY
2696
any_address = "0.0.0.0" # INADDR_ANY
2000
2697
self.server_address = (any_address,
2001
2698
self.server_address[1])
2002
2699
elif not self.server_address[1]:
2003
self.server_address = (self.server_address[0],
2700
self.server_address = (self.server_address[0], 0)
2005
2701
# if self.interface:
2006
2702
# self.server_address = (self.server_address[0],
2032
2733
self.gnutls_priority = gnutls_priority
2033
2734
IPv6_TCPServer.__init__(self, server_address,
2034
2735
RequestHandlerClass,
2035
interface = interface,
2036
use_ipv6 = use_ipv6,
2037
socketfd = socketfd)
2736
interface=interface,
2038
2740
def server_activate(self):
2039
2741
if self.enabled:
2040
2742
return socketserver.TCPServer.server_activate(self)
2042
2744
def enable(self):
2043
2745
self.enabled = True
2045
2747
def add_pipe(self, parent_pipe, proc):
2046
2748
# Call "handle_ipc" for both data and EOF events
2047
gobject.io_add_watch(parent_pipe.fileno(),
2048
gobject.IO_IN | gobject.IO_HUP,
2049
functools.partial(self.handle_ipc,
2054
def handle_ipc(self, source, condition, parent_pipe=None,
2055
proc = None, client_object=None):
2750
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2751
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2752
functools.partial(self.handle_ipc,
2753
parent_pipe=parent_pipe,
2756
def handle_ipc(self, source, condition,
2759
client_object=None):
2056
2760
# error, or the other end of multiprocessing.Pipe has closed
2057
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2761
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2058
2762
# Wait for other process to exit
2062
2766
# Read a request from the child
2063
2767
request = parent_pipe.recv()
2064
2768
command = request[0]
2066
if command == 'init':
2068
address = request[2]
2070
for c in self.clients.itervalues():
2071
if c.fingerprint == fpr:
2770
if command == "init":
2771
key_id = request[1].decode("ascii")
2772
fpr = request[2].decode("ascii")
2773
address = request[3]
2775
for c in self.clients.values():
2776
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2777
"27AE41E4649B934CA495991B7852B855"):
2779
if key_id and c.key_id == key_id:
2782
if fpr and c.fingerprint == fpr:
2075
logger.info("Client not found for fingerprint: %s, ad"
2076
"dress: %s", fpr, address)
2786
log.info("Client not found for key ID: %s, address:"
2787
" %s", key_id or fpr, address)
2077
2788
if self.use_dbus:
2078
2789
# Emit D-Bus signal
2079
mandos_dbus_service.ClientNotFound(fpr,
2790
mandos_dbus_service.ClientNotFound(key_id or fpr,
2081
2792
parent_pipe.send(False)
2084
gobject.io_add_watch(parent_pipe.fileno(),
2085
gobject.IO_IN | gobject.IO_HUP,
2086
functools.partial(self.handle_ipc,
2796
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2797
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2798
functools.partial(self.handle_ipc,
2799
parent_pipe=parent_pipe,
2801
client_object=client))
2092
2802
parent_pipe.send(True)
2093
2803
# remove the old hook in favor of the new above hook on
2096
if command == 'funcall':
2806
if command == "funcall":
2097
2807
funcname = request[1]
2098
2808
args = request[2]
2099
2809
kwargs = request[3]
2101
parent_pipe.send(('data', getattr(client_object,
2811
parent_pipe.send(("data", getattr(client_object,
2102
2812
funcname)(*args,
2105
if command == 'getattr':
2815
if command == "getattr":
2106
2816
attrname = request[1]
2107
if callable(client_object.__getattribute__(attrname)):
2108
parent_pipe.send(('function',))
2817
if isinstance(client_object.__getattribute__(attrname),
2818
collections.abc.Callable):
2819
parent_pipe.send(("function", ))
2110
parent_pipe.send(('data', client_object
2111
.__getattribute__(attrname)))
2113
if command == 'setattr':
2822
"data", client_object.__getattribute__(attrname)))
2824
if command == "setattr":
2114
2825
attrname = request[1]
2115
2826
value = request[2]
2116
2827
setattr(client_object, attrname, value)
2121
2832
def rfc3339_duration_to_delta(duration):
2122
2833
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2124
>>> rfc3339_duration_to_delta("P7D")
2125
datetime.timedelta(7)
2126
>>> rfc3339_duration_to_delta("PT60S")
2127
datetime.timedelta(0, 60)
2128
>>> rfc3339_duration_to_delta("PT60M")
2129
datetime.timedelta(0, 3600)
2130
>>> rfc3339_duration_to_delta("PT24H")
2131
datetime.timedelta(1)
2132
>>> rfc3339_duration_to_delta("P1W")
2133
datetime.timedelta(7)
2134
>>> rfc3339_duration_to_delta("PT5M30S")
2135
datetime.timedelta(0, 330)
2136
>>> rfc3339_duration_to_delta("P1DT3M20S")
2137
datetime.timedelta(1, 200)
2835
>>> timedelta = datetime.timedelta
2836
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2838
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2840
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2842
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2844
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2846
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2848
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2140
2853
# Parsing an RFC 3339 duration with regular expressions is not
2141
2854
# possible - there would have to be multiple places for the same
2142
2855
# values, like seconds. The current code, while more esoteric, is
2143
2856
# cleaner without depending on a parsing library. If Python had a
2144
2857
# built-in library for parsing we would use it, but we'd like to
2145
2858
# avoid excessive use of external libraries.
2147
2860
# New type for defining tokens, syntax, and semantics all-in-one
2148
Token = collections.namedtuple("Token",
2149
("regexp", # To match token; if
2150
# "value" is not None,
2151
# must have a "group"
2153
"value", # datetime.timedelta or
2155
"followers")) # Tokens valid after
2861
Token = collections.namedtuple("Token", (
2862
"regexp", # To match token; if "value" is not None, must have
2863
# a "group" containing digits
2864
"value", # datetime.timedelta or None
2865
"followers")) # Tokens valid after this token
2157
2866
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2158
2867
# the "duration" ABNF definition in RFC 3339, Appendix A.
2159
2868
token_end = Token(re.compile(r"$"), None, frozenset())
2160
2869
token_second = Token(re.compile(r"(\d+)S"),
2161
2870
datetime.timedelta(seconds=1),
2162
frozenset((token_end,)))
2871
frozenset((token_end, )))
2163
2872
token_minute = Token(re.compile(r"(\d+)M"),
2164
2873
datetime.timedelta(minutes=1),
2165
2874
frozenset((token_second, token_end)))
3205
log.debug("Did setuid/setgid to %s:%s", uid, gid)
2494
3206
except OSError as error:
3207
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3208
os.strerror(error.errno))
2495
3209
if error.errno != errno.EPERM:
2499
3213
# Enable all possible GnuTLS debugging
2501
3215
# "Use a log level over 10 to enable all debugging options."
2502
3216
# - GnuTLS manual
2503
gnutls.library.functions.gnutls_global_set_log_level(11)
2505
@gnutls.library.types.gnutls_log_func
3217
gnutls.global_set_log_level(11)
2506
3220
def debug_gnutls(level, string):
2507
logger.debug("GnuTLS: %s", string[:-1])
2509
(gnutls.library.functions
2510
.gnutls_global_set_log_function(debug_gnutls))
3221
log.debug("GnuTLS: %s",
3222
string[:-1].decode("utf-8", errors="replace"))
3224
gnutls.global_set_log_function(debug_gnutls)
2512
3226
# Redirect stdin so all checkers get /dev/null
2513
3227
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2514
3228
os.dup2(null, sys.stdin.fileno())
2518
3232
# Need to fork before connecting to D-Bus
2519
3233
if not foreground:
2520
3234
# Close all input and output, do double fork, etc.
2523
# multiprocessing will use threads, so before we use gobject we
2524
# need to inform gobject that threads will be used.
2525
gobject.threads_init()
3237
if gi.version_info < (3, 10, 2):
3238
# multiprocessing will use threads, so before we use GLib we
3239
# need to inform GLib that threads will be used.
2527
3242
global main_loop
2528
3243
# From the Avahi example code
2529
3244
DBusGMainLoop(set_as_default=True)
2530
main_loop = gobject.MainLoop()
2531
bus = dbus.SystemBus()
3245
main_loop = GLib.MainLoop()
3246
if use_dbus or zeroconf:
3247
bus = dbus.SystemBus()
2532
3248
# End of Avahi example code
2535
3251
bus_name = dbus.service.BusName("se.recompile.Mandos",
2536
bus, do_not_queue=True)
2537
old_bus_name = (dbus.service.BusName
2538
("se.bsnet.fukt.Mandos", bus,
2540
except dbus.exceptions.NameExistsException as e:
2541
logger.error("Disabling D-Bus:", exc_info=e)
3254
old_bus_name = dbus.service.BusName(
3255
"se.bsnet.fukt.Mandos", bus,
3257
except dbus.exceptions.DBusException as e:
3258
log.error("Disabling D-Bus:", exc_info=e)
2542
3259
use_dbus = False
2543
3260
server_settings["use_dbus"] = False
2544
3261
tcp_server.use_dbus = False
2546
3263
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2547
service = AvahiServiceToSyslog(name =
2548
server_settings["servicename"],
2549
servicetype = "_mandos._tcp",
2550
protocol = protocol, bus = bus)
3264
service = AvahiServiceToSyslog(
3265
name=server_settings["servicename"],
3266
servicetype="_mandos._tcp",
2551
3269
if server_settings["interface"]:
2552
service.interface = (if_nametoindex
2553
(server_settings["interface"]
3270
service.interface = if_nametoindex(
3271
server_settings["interface"].encode("utf-8"))
2556
3273
global multiprocessing_manager
2557
3274
multiprocessing_manager = multiprocessing.Manager()
2559
3276
client_class = Client
2561
client_class = functools.partial(ClientDBus, bus = bus)
3278
client_class = functools.partial(ClientDBus, bus=bus)
2563
3280
client_settings = Client.config_parser(client_config)
2564
3281
old_client_settings = {}
2565
3282
clients_data = {}
2567
3284
# This is used to redirect stdout and stderr for checker processes
2569
wnull = open(os.devnull, "w") # A writable /dev/null
3286
wnull = open(os.devnull, "w") # A writable /dev/null
2570
3287
# Only used if server is running in foreground but not in debug
2572
3289
if debug or not foreground:
2575
3292
# Get client data and settings from last running state.
2576
3293
if server_settings["restore"]:
2578
3295
with open(stored_state_path, "rb") as stored_state:
2579
clients_data, old_client_settings = (pickle.load
3296
if sys.version_info.major == 2:
3297
clients_data, old_client_settings = pickle.load(
3300
bytes_clients_data, bytes_old_client_settings = (
3301
pickle.load(stored_state, encoding="bytes"))
3302
# Fix bytes to strings
3305
clients_data = {(key.decode("utf-8")
3306
if isinstance(key, bytes)
3309
bytes_clients_data.items()}
3310
del bytes_clients_data
3311
for key in clients_data:
3312
value = {(k.decode("utf-8")
3313
if isinstance(k, bytes) else k): v
3315
clients_data[key].items()}
3316
clients_data[key] = value
3318
value["client_structure"] = [
3320
if isinstance(s, bytes)
3322
value["client_structure"]]
3323
# .name, .host, and .checker_command
3324
for k in ("name", "host", "checker_command"):
3325
if isinstance(value[k], bytes):
3326
value[k] = value[k].decode("utf-8")
3327
if "key_id" not in value:
3328
value["key_id"] = ""
3329
elif "fingerprint" not in value:
3330
value["fingerprint"] = ""
3331
# old_client_settings
3333
old_client_settings = {
3334
(key.decode("utf-8")
3335
if isinstance(key, bytes)
3338
bytes_old_client_settings.items()}
3339
del bytes_old_client_settings
3340
# .host and .checker_command
3341
for value in old_client_settings.values():
3342
for attribute in ("host", "checker_command"):
3343
if isinstance(value[attribute], bytes):
3344
value[attribute] = (value[attribute]
2581
3346
os.remove(stored_state_path)
2582
3347
except IOError as e:
2583
3348
if e.errno == errno.ENOENT:
2584
logger.warning("Could not load persistent state: {}"
2585
.format(os.strerror(e.errno)))
3349
log.warning("Could not load persistent state:"
3350
" %s", os.strerror(e.errno))
2587
logger.critical("Could not load persistent state:",
3352
log.critical("Could not load persistent state:",
2590
3355
except EOFError as e:
2591
logger.warning("Could not load persistent state: "
2592
"EOFError:", exc_info=e)
3356
log.warning("Could not load persistent state: EOFError:",
2594
3359
with PGPEngine() as pgp:
2595
3360
for client_name, client in clients_data.items():
2596
3361
# Skip removed clients
2597
3362
if client_name not in client_settings:
2600
3365
# Decide which value to use after restoring saved state.
2601
3366
# We have three different values: Old config file,
2602
3367
# new config file, and saved state.
2660
3421
for client_name in (set(client_settings)
2661
3422
- set(old_client_settings)):
2662
3423
clients_data[client_name] = client_settings[client_name]
2664
3425
# Create all client objects
2665
3426
for client_name, client in clients_data.items():
2666
3427
tcp_server.clients[client_name] = client_class(
2667
name = client_name, settings = client,
2668
server_settings = server_settings)
3430
server_settings=server_settings)
2670
3432
if not tcp_server.clients:
2671
logger.warning("No clients defined")
3433
log.warning("No clients defined")
2673
3435
if not foreground:
2674
3436
if pidfile is not None:
2678
pidfile.write("{}\n".format(pid).encode("utf-8"))
3440
print(pid, file=pidfile)
2679
3441
except IOError:
2680
logger.error("Could not write to file %r with PID %d",
3442
log.error("Could not write to file %r with PID %d",
2683
3445
del pidfilename
2685
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2686
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3447
for termsig in (signal.SIGHUP, signal.SIGTERM):
3448
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3449
lambda: main_loop.quit() and False)
2689
@alternate_dbus_interfaces({"se.recompile.Mandos":
2690
"se.bsnet.fukt.Mandos"})
2691
class MandosDBusService(DBusObjectWithProperties):
3453
@alternate_dbus_interfaces(
3454
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3455
class MandosDBusService(DBusObjectWithObjectManager):
2692
3456
"""A D-Bus proxy object"""
2693
3458
def __init__(self):
2694
3459
dbus.service.Object.__init__(self, bus, "/")
2695
3461
_interface = "se.recompile.Mandos"
2697
@dbus_interface_annotations(_interface)
2699
return { "org.freedesktop.DBus.Property"
2700
".EmitsChangedSignal":
2703
3463
@dbus.service.signal(_interface, signature="o")
2704
3464
def ClientAdded(self, objpath):
2708
3468
@dbus.service.signal(_interface, signature="ss")
2709
def ClientNotFound(self, fingerprint, address):
3469
def ClientNotFound(self, key_id, address):
3473
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2713
3475
@dbus.service.signal(_interface, signature="os")
2714
3476
def ClientRemoved(self, objpath, name):
3480
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2718
3482
@dbus.service.method(_interface, out_signature="ao")
2719
3483
def GetAllClients(self):
2721
return dbus.Array(c.dbus_object_path
2723
tcp_server.clients.itervalues())
3485
return dbus.Array(c.dbus_object_path for c in
3486
tcp_server.clients.values())
3488
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2725
3490
@dbus.service.method(_interface,
2726
3491
out_signature="a{oa{sv}}")
2727
3492
def GetAllClientsWithProperties(self):
2729
3494
return dbus.Dictionary(
2730
{ c.dbus_object_path: c.GetAll("")
2731
for c in tcp_server.clients.itervalues() },
3495
{c.dbus_object_path: c.GetAll(
3496
"se.recompile.Mandos.Client")
3497
for c in tcp_server.clients.values()},
2732
3498
signature="oa{sv}")
2734
3500
@dbus.service.method(_interface, in_signature="o")
2735
3501
def RemoveClient(self, object_path):
2737
for c in tcp_server.clients.itervalues():
3503
for c in tcp_server.clients.values():
2738
3504
if c.dbus_object_path == object_path:
2739
3505
del tcp_server.clients[c.name]
2740
3506
c.remove_from_connection()
2741
# Don't signal anything except ClientRemoved
3507
# Don't signal the disabling
2742
3508
c.disable(quiet=True)
2744
self.ClientRemoved(object_path, c.name)
3509
# Emit D-Bus signal for removal
3510
self.client_removed_signal(c)
2746
3512
raise KeyError(object_path)
3516
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3517
out_signature="a{oa{sa{sv}}}")
3518
def GetManagedObjects(self):
3520
return dbus.Dictionary(
3521
{client.dbus_object_path:
3523
{interface: client.GetAll(interface)
3525
client._get_all_interface_names()})
3526
for client in tcp_server.clients.values()})
3528
def client_added_signal(self, client):
3529
"""Send the new standard signal and the old signal"""
3531
# New standard signal
3532
self.InterfacesAdded(
3533
client.dbus_object_path,
3535
{interface: client.GetAll(interface)
3537
client._get_all_interface_names()}))
3539
self.ClientAdded(client.dbus_object_path)
3541
def client_removed_signal(self, client):
3542
"""Send the new standard signal and the old signal"""
3544
# New standard signal
3545
self.InterfacesRemoved(
3546
client.dbus_object_path,
3547
client._get_all_interface_names())
3549
self.ClientRemoved(client.dbus_object_path,
2750
3552
mandos_dbus_service = MandosDBusService()
3554
# Save modules to variables to exempt the modules from being
3555
# unloaded before the function registered with atexit() is run.
3556
mp = multiprocessing
2753
3560
"Cleanup function; run on exit"
2755
3562
service.cleanup()
2757
multiprocessing.active_children()
3564
mp.active_children()
2759
3566
if not (tcp_server.clients or client_settings):
2762
3569
# Store client before exiting. Secrets are encrypted with key
2763
3570
# based on what config file has. If config file is
2764
3571
# removed/edited, old secret will thus be unrecovable.
2766
3573
with PGPEngine() as pgp:
2767
for client in tcp_server.clients.itervalues():
3574
for client in tcp_server.clients.values():
2768
3575
key = client_settings[client.name]["secret"]
2769
3576
client.encrypted_secret = pgp.encrypt(client.secret,
2771
3578
client_dict = {}
2773
3580
# A list of attributes that can not be pickled
2775
exclude = { "bus", "changedstate", "secret",
2776
"checker", "server_settings" }
2777
for name, typ in (inspect.getmembers
2778
(dbus.service.Object)):
3582
exclude = {"bus", "changedstate", "secret",
3583
"checker", "server_settings"}
3584
for name, typ in inspect.getmembers(dbus.service
2779
3586
exclude.add(name)
2781
3588
client_dict["encrypted_secret"] = (client
2782
3589
.encrypted_secret)
2783
3590
for attr in client.client_structure:
2784
3591
if attr not in exclude:
2785
3592
client_dict[attr] = getattr(client, attr)
2787
3594
clients[client.name] = client_dict
2788
3595
del client_settings[client.name]["secret"]
2791
with (tempfile.NamedTemporaryFile
2792
(mode='wb', suffix=".pickle", prefix='clients-',
2793
dir=os.path.dirname(stored_state_path),
2794
delete=False)) as stored_state:
2795
pickle.dump((clients, client_settings), stored_state)
2796
tempname=stored_state.name
3598
with tempfile.NamedTemporaryFile(
3602
dir=os.path.dirname(stored_state_path),
3603
delete=False) as stored_state:
3604
pickle.dump((clients, client_settings), stored_state,
3606
tempname = stored_state.name
2797
3607
os.rename(tempname, stored_state_path)
2798
3608
except (IOError, OSError) as e:
2802
3612
except NameError:
2804
3614
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2805
logger.warning("Could not save persistent state: {}"
2806
.format(os.strerror(e.errno)))
3615
log.warning("Could not save persistent state: %s",
3616
os.strerror(e.errno))
2808
logger.warning("Could not save persistent state:",
3618
log.warning("Could not save persistent state:",
2812
3622
# Delete all clients, and settings from config
2813
3623
while tcp_server.clients:
2814
3624
name, client = tcp_server.clients.popitem()
2816
3626
client.remove_from_connection()
2817
# Don't signal anything except ClientRemoved
3627
# Don't signal the disabling
2818
3628
client.disable(quiet=True)
3629
# Emit D-Bus signal for removal
2821
mandos_dbus_service.ClientRemoved(client
3631
mandos_dbus_service.client_removed_signal(client)
2824
3632
client_settings.clear()
2826
3634
atexit.register(cleanup)
2828
for client in tcp_server.clients.itervalues():
3636
for client in tcp_server.clients.values():
2831
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3638
# Emit D-Bus signal for adding
3639
mandos_dbus_service.client_added_signal(client)
2832
3640
# Need to initiate checking of clients
2833
3641
if client.enabled:
2834
client.init_checker()
3642
client.init_checker(randomize_start=True)
2836
3644
tcp_server.enable()
2837
3645
tcp_server.server_activate()
2839
3647
# Find out what port we got
2841
3649
service.port = tcp_server.socket.getsockname()[1]
2843
logger.info("Now listening on address %r, port %d,"
2844
" flowinfo %d, scope_id %d",
2845
*tcp_server.socket.getsockname())
3651
log.info("Now listening on address %r, port %d, flowinfo %d,"
3652
" scope_id %d", *tcp_server.socket.getsockname())
2847
logger.info("Now listening on address %r, port %d",
2848
*tcp_server.socket.getsockname())
2850
#service.interface = tcp_server.socket.getsockname()[3]
3654
log.info("Now listening on address %r, port %d",
3655
*tcp_server.socket.getsockname())
3657
# service.interface = tcp_server.socket.getsockname()[3]
2854
3661
# From the Avahi example code
2856
3663
service.activate()
2857
3664
except dbus.exceptions.DBusException as error:
2858
logger.critical("D-Bus Exception", exc_info=error)
3665
log.critical("D-Bus Exception", exc_info=error)
2861
3668
# End of Avahi example code
2863
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2864
lambda *args, **kwargs:
2865
(tcp_server.handle_request
2866
(*args[2:], **kwargs) or True))
2868
logger.debug("Starting main loop")
3671
GLib.IOChannel.unix_new(tcp_server.fileno()),
3672
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3673
lambda *args, **kwargs: (tcp_server.handle_request
3674
(*args[2:], **kwargs) or True))
3676
log.debug("Starting main loop")
2869
3677
main_loop.run()
2870
3678
except AvahiError as error:
2871
logger.critical("Avahi Error", exc_info=error)
3679
log.critical("Avahi Error", exc_info=error)
2874
3682
except KeyboardInterrupt:
2876
3684
print("", file=sys.stderr)
2877
logger.debug("Server received KeyboardInterrupt")
2878
logger.debug("Server exiting")
3685
log.debug("Server received KeyboardInterrupt")
3686
log.debug("Server exiting")
2879
3687
# Must run before the D-Bus bus name gets deregistered
2882
if __name__ == '__main__':
3691
def parse_test_args():
3692
# type: () -> argparse.Namespace
3693
parser = argparse.ArgumentParser(add_help=False)
3694
parser.add_argument("--check", action="store_true")
3695
parser.add_argument("--prefix", )
3696
args, unknown_args = parser.parse_known_args()
3698
# Remove test options from sys.argv
3699
sys.argv[1:] = unknown_args
3702
# Add all tests from doctest strings
3703
def load_tests(loader, tests, none):
3705
tests.addTests(doctest.DocTestSuite())
3708
if __name__ == "__main__":
3709
options = parse_test_args()
3712
extra_test_prefix = options.prefix
3713
if extra_test_prefix is not None:
3714
if not (unittest.main(argv=[""], exit=False)
3715
.result.wasSuccessful()):
3717
class ExtraTestLoader(unittest.TestLoader):
3718
testMethodPrefix = extra_test_prefix
3719
# Call using ./scriptname --test [--verbose]
3720
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3722
unittest.main(argv=[""])
3730
# (lambda (&optional extra)
3731
# (if (not (funcall run-tests-in-test-buffer default-directory
3733
# (funcall show-test-buffer-in-test-window)
3734
# (funcall remove-test-window)
3735
# (if extra (message "Extra tests run successfully!"))))
3736
# run-tests-in-test-buffer:
3737
# (lambda (dir &optional extra)
3738
# (with-current-buffer (get-buffer-create "*Test*")
3739
# (setq buffer-read-only nil
3740
# default-directory dir)
3742
# (compilation-mode))
3743
# (let ((process-result
3744
# (let ((inhibit-read-only t))
3745
# (process-file-shell-command
3746
# (funcall get-command-line extra) nil "*Test*"))))
3747
# (and (numberp process-result)
3748
# (= process-result 0))))
3750
# (lambda (&optional extra)
3751
# (let ((quoted-script
3752
# (shell-quote-argument (funcall get-script-name))))
3754
# (concat "%s --check" (if extra " --prefix=atest" ""))
3758
# (if (fboundp 'file-local-name)
3759
# (file-local-name (buffer-file-name))
3760
# (or (file-remote-p (buffer-file-name) 'localname)
3761
# (buffer-file-name))))
3762
# remove-test-window:
3764
# (let ((test-window (get-buffer-window "*Test*")))
3765
# (if test-window (delete-window test-window))))
3766
# show-test-buffer-in-test-window:
3768
# (when (not (get-buffer-window-list "*Test*"))
3769
# (setq next-error-last-buffer (get-buffer "*Test*"))
3770
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3771
# (display-buffer-overriding-action
3772
# `((display-buffer-in-side-window) (side . ,side)
3773
# (window-height . fit-window-to-buffer)
3774
# (window-width . fit-window-to-buffer))))
3775
# (display-buffer "*Test*"))))
3778
# (let* ((run-extra-tests (lambda () (interactive)
3779
# (funcall run-tests t)))
3780
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3781
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3782
# (setq minor-mode-overriding-map-alist
3783
# (cons `(run-tests . ,outer-keymap)
3784
# minor-mode-overriding-map-alist)))
3785
# (add-hook 'after-save-hook run-tests 90 t))