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
1023
self.current_checker_command = None
544
1024
self.approved = None
545
1025
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()
1026
self.changedstate = multiprocessing_manager.Condition(
1027
multiprocessing_manager.Lock())
1028
self.client_structure = [attr
1029
for attr in self.__dict__.keys()
551
1030
if not attr.startswith("_")]
552
1031
self.client_structure.append("client_structure")
554
for name, t in inspect.getmembers(type(self),
1033
for name, t in inspect.getmembers(
1034
type(self), lambda obj: isinstance(obj, property)):
558
1035
if not name.startswith("_"):
559
1036
self.client_structure.append(name)
561
1038
# Send notice to process children that client state has changed
562
1039
def send_changedstate(self):
563
1040
with self.changedstate:
564
1041
self.changedstate.notify_all()
566
1043
def enable(self):
567
1044
"""Start this client's checker and timeout hooks"""
568
1045
if getattr(self, "enabled", False):
569
1046
# Already enabled
571
self.expires = datetime.datetime.utcnow() + self.timeout
572
1048
self.enabled = True
573
1049
self.last_enabled = datetime.datetime.utcnow()
574
1050
self.init_checker()
575
1051
self.send_changedstate()
577
1053
def disable(self, quiet=True):
578
1054
"""Disable this client."""
579
1055
if not getattr(self, "enabled", False):
582
logger.info("Disabling client %s", self.name)
1058
log.info("Disabling client %s", self.name)
583
1059
if getattr(self, "disable_initiator_tag", None) is not None:
584
gobject.source_remove(self.disable_initiator_tag)
1060
GLib.source_remove(self.disable_initiator_tag)
585
1061
self.disable_initiator_tag = None
586
1062
self.expires = None
587
1063
if getattr(self, "checker_initiator_tag", None) is not None:
588
gobject.source_remove(self.checker_initiator_tag)
1064
GLib.source_remove(self.checker_initiator_tag)
589
1065
self.checker_initiator_tag = None
590
1066
self.stop_checker()
591
1067
self.enabled = False
593
1069
self.send_changedstate()
594
# Do not run this again if called by a gobject.timeout_add
1070
# Do not run this again if called by a GLib.timeout_add
597
1073
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.
1076
def init_checker(self, randomize_start=False):
1077
# Schedule a new checker to be started a randomly selected
1078
# time (a fraction of 'interval') from now. This spreads out
1079
# the startup of checkers over time when the server is
603
1081
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
1082
GLib.source_remove(self.checker_initiator_tag)
1083
interval_milliseconds = int(self.interval.total_seconds()
1086
delay_milliseconds = random.randrange(
1087
interval_milliseconds + 1)
1089
delay_milliseconds = interval_milliseconds
1090
self.checker_initiator_tag = GLib.timeout_add(
1091
delay_milliseconds, self.start_checker, randomize_start)
1092
delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1093
# A checker might take up to an 'interval' of time, so we can
1094
# expire at the soonest one interval after a checker was
1095
# started. Since the initial checker is delayed, the expire
1096
# time might have to be extended.
1097
now = datetime.datetime.utcnow()
1098
self.expires = now + delay + self.interval
1099
# Schedule a disable() at expire time
610
1100
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):
1101
GLib.source_remove(self.disable_initiator_tag)
1102
self.disable_initiator_tag = GLib.timeout_add(
1103
int((self.expires - now).total_seconds() * 1000),
1106
def checker_callback(self, source, condition, connection,
620
1108
"""The checker has completed, so take appropriate actions."""
1109
# Read return code from connection (see call_pipe)
1110
returncode = connection.recv()
1112
if self.checker is not None:
621
1114
self.checker_callback_tag = None
622
1115
self.checker = None
623
if os.WIFEXITED(condition):
624
self.last_checker_status = os.WEXITSTATUS(condition)
1118
self.last_checker_status = returncode
1119
self.last_checker_signal = None
625
1120
if self.last_checker_status == 0:
626
logger.info("Checker for %(name)s succeeded",
1121
log.info("Checker for %(name)s succeeded", vars(self))
628
1122
self.checked_ok()
630
logger.info("Checker for %(name)s failed",
1124
log.info("Checker for %(name)s failed", vars(self))
633
1126
self.last_checker_status = -1
634
logger.warning("Checker for %(name)s crashed?",
1127
self.last_checker_signal = -returncode
1128
log.warning("Checker for %(name)s crashed?", vars(self))
637
1131
def checked_ok(self):
638
1132
"""Assert that the client has been seen, alive and well."""
639
1133
self.last_checked_ok = datetime.datetime.utcnow()
640
1134
self.last_checker_status = 0
1135
self.last_checker_signal = None
641
1136
self.bump_timeout()
643
1138
def bump_timeout(self, timeout=None):
644
1139
"""Bump up the timeout for this client."""
645
1140
if timeout is None:
646
1141
timeout = self.timeout
647
1142
if self.disable_initiator_tag is not None:
648
gobject.source_remove(self.disable_initiator_tag)
1143
GLib.source_remove(self.disable_initiator_tag)
649
1144
self.disable_initiator_tag = None
650
1145
if getattr(self, "enabled", False):
651
self.disable_initiator_tag = (gobject.timeout_add
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
1146
self.disable_initiator_tag = GLib.timeout_add(
1147
int(timeout.total_seconds() * 1000), self.disable)
654
1148
self.expires = datetime.datetime.utcnow() + timeout
656
1150
def need_approval(self):
657
1151
self.last_approval_request = datetime.datetime.utcnow()
659
def start_checker(self):
1153
def start_checker(self, start_was_randomized=False):
660
1154
"""Start a new checker subprocess if one is not running.
662
1156
If a checker already exists, leave it running and do
664
1158
# The reason for not killing a running checker is that if we
669
1163
# checkers alone, the checker would have to take more time
670
1164
# 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)
1167
if self.checker is not None and not self.checker.is_alive():
1168
log.warning("Checker was not alive; joining")
687
1171
# Start a new checker if needed
688
1172
if self.checker is None:
689
1173
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(str(getattr(self, attr)))
692
for attr in self.runtime_expansions }
1175
attr: shlex.quote(str(getattr(self, attr)))
1176
for attr in self.runtime_expansions}
694
1178
command = self.checker_command % escaped_attrs
695
1179
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
1180
log.error('Could not format string "%s"',
1181
self.checker_command, exc_info=error)
1182
return True # Try again later
699
1183
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
1184
log.info("Starting checker %r for %s", command, self.name)
1185
# We don't need to redirect stdout and stderr, since
1186
# in normal mode, that is already done by daemon(),
1187
# and in debug mode we don't want to. (Stdin is
1188
# always replaced by /dev/null.)
1189
# The exception is when not debugging but nevertheless
1190
# running in the foreground; use the previously
1192
popen_args = {"close_fds": True,
1195
if (not self.server_settings["debug"]
1196
and self.server_settings["foreground"]):
1197
popen_args.update({"stdout": wnull,
1199
pipe = multiprocessing.Pipe(duplex=False)
1200
self.checker = multiprocessing.Process(
1202
args=(pipe[1], subprocess.call, command),
1204
self.checker.start()
1205
self.checker_callback_tag = GLib.io_add_watch(
1206
GLib.IOChannel.unix_new(pipe[0].fileno()),
1207
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1208
self.checker_callback, pipe[0], command)
1209
if start_was_randomized:
1210
# We were started after a random delay; Schedule a new
1211
# checker to be started an 'interval' from now, and every
1212
# interval from then on.
1213
now = datetime.datetime.utcnow()
1214
self.checker_initiator_tag = GLib.timeout_add(
1215
int(self.interval.total_seconds() * 1000),
1217
self.expires = max(self.expires, now + self.interval)
1218
# Don't start a new checker again after same random delay
1220
# Re-run this periodically if run by GLib.timeout_add
744
1223
def stop_checker(self):
745
1224
"""Force the checker process, if any, to stop."""
746
1225
if self.checker_callback_tag:
747
gobject.source_remove(self.checker_callback_tag)
1226
GLib.source_remove(self.checker_callback_tag)
748
1227
self.checker_callback_tag = None
749
1228
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
1230
log.debug("Stopping checker for %(name)s", vars(self))
1231
self.checker.terminate()
760
1232
self.checker = None
763
def dbus_service_property(dbus_interface, signature="v",
764
access="readwrite", byte_arrays=False):
1235
def dbus_service_property(dbus_interface,
765
1239
"""Decorators for marking methods of a DBusObjectWithProperties to
766
1240
become properties on the D-Bus.
768
1242
The decorated method will be called with no arguments by "Get"
769
1243
and with one argument by "Set".
771
1245
The parameters, where they are supported, are the same as
772
1246
dbus.service.method, except there is only "signature", since the
773
1247
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.
1330
class DBusObjectWithAnnotations(dbus.service.Object):
1331
"""A D-Bus object with annotations.
1333
Classes inheriting from this can use the dbus_annotations
1334
decorator to add annotations to methods or signals.
856
1338
def _is_dbus_thing(thing):
857
1339
"""Returns a function testing if an attribute is a D-Bus thing
859
1341
If called like _is_dbus_thing("method") it returns a function
860
1342
suitable for use as predicate to inspect.getmembers().
862
1344
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
865
1347
def _get_all_dbus_things(self, thing):
866
1348
"""Returns a generator of (name, attribute) pairs
868
return ((getattr(athing.__get__(self), "_dbus_name",
1350
return ((getattr(athing.__get__(self), "_dbus_name", name),
870
1351
athing.__get__(self))
871
1352
for cls in self.__class__.__mro__
872
1353
for name, athing in
873
inspect.getmembers(cls,
874
self._is_dbus_thing(thing)))
1354
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1356
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1358
path_keyword="object_path",
1359
connection_keyword="connection")
1360
def Introspect(self, object_path, connection):
1361
"""Overloading of standard D-Bus method.
1363
Inserts annotation tags on methods and signals.
1365
xmlstring = dbus.service.Object.Introspect(self, object_path,
1368
document = xml.dom.minidom.parseString(xmlstring)
1370
for if_tag in document.getElementsByTagName("interface"):
1371
# Add annotation tags
1372
for typ in ("method", "signal"):
1373
for tag in if_tag.getElementsByTagName(typ):
1375
for name, prop in (self.
1376
_get_all_dbus_things(typ)):
1377
if (name == tag.getAttribute("name")
1378
and prop._dbus_interface
1379
== if_tag.getAttribute("name")):
1380
annots.update(getattr(
1381
prop, "_dbus_annotations", {}))
1382
for name, value in annots.items():
1383
ann_tag = document.createElement(
1385
ann_tag.setAttribute("name", name)
1386
ann_tag.setAttribute("value", value)
1387
tag.appendChild(ann_tag)
1388
# Add interface annotation tags
1389
for annotation, value in dict(
1390
itertools.chain.from_iterable(
1391
annotations().items()
1392
for name, annotations
1393
in self._get_all_dbus_things("interface")
1394
if name == if_tag.getAttribute("name")
1396
ann_tag = document.createElement("annotation")
1397
ann_tag.setAttribute("name", annotation)
1398
ann_tag.setAttribute("value", value)
1399
if_tag.appendChild(ann_tag)
1400
# Fix argument name for the Introspect method itself
1401
if (if_tag.getAttribute("name")
1402
== dbus.INTROSPECTABLE_IFACE):
1403
for cn in if_tag.getElementsByTagName("method"):
1404
if cn.getAttribute("name") == "Introspect":
1405
for arg in cn.getElementsByTagName("arg"):
1406
if (arg.getAttribute("direction")
1408
arg.setAttribute("name",
1410
xmlstring = document.toxml("utf-8")
1412
except (AttributeError, xml.dom.DOMException,
1413
xml.parsers.expat.ExpatError) as error:
1414
log.error("Failed to override Introspection method",
1419
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1420
"""A D-Bus object with properties.
1422
Classes inheriting from this can use the dbus_service_property
1423
decorator to expose methods as D-Bus properties. It exposes the
1424
standard Get(), Set(), and GetAll() methods on the D-Bus.
876
1427
def _get_dbus_property(self, interface_name, property_name):
877
1428
"""Returns a bound method if one exists which is a D-Bus
878
1429
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"))):
1431
for cls in self.__class__.__mro__:
1432
for name, value in inspect.getmembers(
1433
cls, self._is_dbus_thing("property")):
884
1434
if (value._dbus_name == property_name
885
1435
and value._dbus_interface == interface_name):
886
1436
return value.__get__(self)
888
1438
# No such property
889
raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
+ interface_name + "."
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1439
raise DBusPropertyNotFound("{}:{}.{}".format(
1440
self.dbus_object_path, interface_name, property_name))
1443
def _get_all_interface_names(cls):
1444
"""Get a sequence of all interfaces supported by an object"""
1445
return (name for name in set(getattr(getattr(x, attr),
1446
"_dbus_interface", None)
1447
for x in (inspect.getmro(cls))
1449
if name is not None)
1451
@dbus.service.method(dbus.PROPERTIES_IFACE,
894
1453
out_signature="v")
895
1454
def Get(self, interface_name, property_name):
896
1455
"""Standard D-Bus property Get() method, see D-Bus standard.
1031
1578
document.unlink()
1032
1579
except (AttributeError, xml.dom.DOMException,
1033
1580
xml.parsers.expat.ExpatError) as error:
1034
logger.error("Failed to override Introspection method",
1581
log.error("Failed to override Introspection method",
1587
dbus.OBJECT_MANAGER_IFACE
1588
except AttributeError:
1589
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1592
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1593
"""A D-Bus object with an ObjectManager.
1595
Classes inheriting from this exposes the standard
1596
GetManagedObjects call and the InterfacesAdded and
1597
InterfacesRemoved signals on the standard
1598
"org.freedesktop.DBus.ObjectManager" interface.
1600
Note: No signals are sent automatically; they must be sent
1603
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1604
out_signature="a{oa{sa{sv}}}")
1605
def GetManagedObjects(self):
1606
"""This function must be overridden"""
1607
raise NotImplementedError()
1609
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1610
signature="oa{sa{sv}}")
1611
def InterfacesAdded(self, object_path, interfaces_and_properties):
1614
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1615
def InterfacesRemoved(self, object_path, interfaces):
1618
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1620
path_keyword="object_path",
1621
connection_keyword="connection")
1622
def Introspect(self, object_path, connection):
1623
"""Overloading of standard D-Bus method.
1625
Override return argument name of GetManagedObjects to be
1626
"objpath_interfaces_and_properties"
1628
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1632
document = xml.dom.minidom.parseString(xmlstring)
1634
for if_tag in document.getElementsByTagName("interface"):
1635
# Fix argument name for the GetManagedObjects method
1636
if (if_tag.getAttribute("name")
1637
== dbus.OBJECT_MANAGER_IFACE):
1638
for cn in if_tag.getElementsByTagName("method"):
1639
if (cn.getAttribute("name")
1640
== "GetManagedObjects"):
1641
for arg in cn.getElementsByTagName("arg"):
1642
if (arg.getAttribute("direction")
1646
"objpath_interfaces"
1648
xmlstring = document.toxml("utf-8")
1650
except (AttributeError, xml.dom.DOMException,
1651
xml.parsers.expat.ExpatError) as error:
1652
log.error("Failed to override Introspection method",
1036
1654
return xmlstring
1039
1657
def datetime_to_dbus(dt, variant_level=0):
1040
1658
"""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)
1660
return dbus.String("", variant_level=variant_level)
1661
return dbus.String(dt.isoformat(), variant_level=variant_level)
1047
1664
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1407
2025
server to mandos-client
1411
2029
# Rejected - signal
1412
2030
@dbus.service.signal(_interface, signature="s")
1413
2031
def Rejected(self, reason):
1417
2035
# NeedApproval - signal
1418
2036
@dbus.service.signal(_interface, signature="tb")
1419
2037
def NeedApproval(self, timeout, default):
1421
2039
return self.need_approval()
1425
2043
# Approve - method
1426
2044
@dbus.service.method(_interface, in_signature="b")
1427
2045
def Approve(self, value):
1428
2046
self.approve(value)
1430
2048
# CheckedOK - method
1431
2049
@dbus.service.method(_interface)
1432
2050
def CheckedOK(self):
1433
2051
self.checked_ok()
1435
2053
# Enable - method
2054
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1436
2055
@dbus.service.method(_interface)
1437
2056
def Enable(self):
1441
2060
# StartChecker - method
2061
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1442
2062
@dbus.service.method(_interface)
1443
2063
def StartChecker(self):
1445
2065
self.start_checker()
1447
2067
# Disable - method
2068
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1448
2069
@dbus.service.method(_interface)
1449
2070
def Disable(self):
1453
2074
# StopChecker - method
2075
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1454
2076
@dbus.service.method(_interface)
1455
2077
def StopChecker(self):
1456
2078
self.stop_checker()
1460
2082
# ApprovalPending - property
1461
2083
@dbus_service_property(_interface, signature="b", access="read")
1462
2084
def ApprovalPending_dbus_property(self):
1463
2085
return dbus.Boolean(bool(self.approvals_pending))
1465
2087
# ApprovedByDefault - property
1466
@dbus_service_property(_interface, signature="b",
2088
@dbus_service_property(_interface,
1467
2090
access="readwrite")
1468
2091
def ApprovedByDefault_dbus_property(self, value=None):
1469
2092
if value is None: # get
1470
2093
return dbus.Boolean(self.approved_by_default)
1471
2094
self.approved_by_default = bool(value)
1473
2096
# ApprovalDelay - property
1474
@dbus_service_property(_interface, signature="t",
2097
@dbus_service_property(_interface,
1475
2099
access="readwrite")
1476
2100
def ApprovalDelay_dbus_property(self, value=None):
1477
2101
if value is None: # get
1478
2102
return dbus.UInt64(self.approval_delay.total_seconds()
1480
2104
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1482
2106
# ApprovalDuration - property
1483
@dbus_service_property(_interface, signature="t",
2107
@dbus_service_property(_interface,
1484
2109
access="readwrite")
1485
2110
def ApprovalDuration_dbus_property(self, value=None):
1486
2111
if value is None: # get
1487
2112
return dbus.UInt64(self.approval_duration.total_seconds()
1489
2114
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1491
2116
# Name - property
2118
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1492
2119
@dbus_service_property(_interface, signature="s", access="read")
1493
2120
def Name_dbus_property(self):
1494
2121
return dbus.String(self.name)
2125
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2126
@dbus_service_property(_interface, signature="s", access="read")
2127
def KeyID_dbus_property(self):
2128
return dbus.String(self.key_id)
1496
2130
# Fingerprint - property
2132
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1497
2133
@dbus_service_property(_interface, signature="s", access="read")
1498
2134
def Fingerprint_dbus_property(self):
1499
2135
return dbus.String(self.fingerprint)
1501
2137
# Host - property
1502
@dbus_service_property(_interface, signature="s",
2138
@dbus_service_property(_interface,
1503
2140
access="readwrite")
1504
2141
def Host_dbus_property(self, value=None):
1505
2142
if value is None: # get
1506
2143
return dbus.String(self.host)
1507
2144
self.host = str(value)
1509
2146
# Created - property
2148
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1510
2149
@dbus_service_property(_interface, signature="s", access="read")
1511
2150
def Created_dbus_property(self):
1512
2151
return datetime_to_dbus(self.created)
1514
2153
# LastEnabled - property
1515
2154
@dbus_service_property(_interface, signature="s", access="read")
1516
2155
def LastEnabled_dbus_property(self):
1517
2156
return datetime_to_dbus(self.last_enabled)
1519
2158
# Enabled - property
1520
@dbus_service_property(_interface, signature="b",
2159
@dbus_service_property(_interface,
1521
2161
access="readwrite")
1522
2162
def Enabled_dbus_property(self, value=None):
1523
2163
if value is None: # get
1620
2264
self.start_checker()
1622
2266
self.stop_checker()
1624
2268
# ObjectPath - property
2270
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2271
"org.freedesktop.DBus.Deprecated": "true"})
1625
2272
@dbus_service_property(_interface, signature="o", access="read")
1626
2273
def ObjectPath_dbus_property(self):
1627
return self.dbus_object_path # is already a dbus.ObjectPath
2274
return self.dbus_object_path # is already a dbus.ObjectPath
1629
2276
# Secret = property
1630
@dbus_service_property(_interface, signature="ay",
1631
access="write", byte_arrays=True)
2278
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2280
@dbus_service_property(_interface,
1632
2284
def Secret_dbus_property(self, value):
1633
2285
self.secret = bytes(value)
1638
class ProxyClient(object):
1639
def __init__(self, child_pipe, fpr, address):
2291
def __init__(self, child_pipe, key_id, fpr, address):
1640
2292
self._pipe = child_pipe
1641
self._pipe.send(('init', fpr, address))
2293
self._pipe.send(("init", key_id, fpr, address))
1642
2294
if not self._pipe.recv():
2295
raise KeyError(key_id or fpr)
1645
2297
def __getattribute__(self, name):
1647
2299
return super(ProxyClient, self).__getattribute__(name)
1648
self._pipe.send(('getattr', name))
2300
self._pipe.send(("getattr", name))
1649
2301
data = self._pipe.recv()
1650
if data[0] == 'data':
2302
if data[0] == "data":
1652
if data[0] == 'function':
2304
if data[0] == "function":
1653
2306
def func(*args, **kwargs):
1654
self._pipe.send(('funcall', name, args, kwargs))
2307
self._pipe.send(("funcall", name, args, kwargs))
1655
2308
return self._pipe.recv()[1]
1658
2312
def __setattr__(self, name, value):
1660
2314
return super(ProxyClient, self).__setattr__(name, value)
1661
self._pipe.send(('setattr', name, value))
2315
self._pipe.send(("setattr", name, value))
1664
2318
class ClientHandler(socketserver.BaseRequestHandler, object):
1665
2319
"""A class to handle client connections.
1667
2321
Instantiated once for each connection to handle it.
1668
2322
Note: This will run in its own forked process."""
1670
2324
def handle(self):
1671
2325
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",
2326
log.info("TCP connection from: %s",
2327
str(self.client_address))
2328
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2330
session = gnutls.ClientSession(self.request)
2332
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2333
# "+AES-256-CBC", "+SHA1",
2334
# "+COMP-NULL", "+CTYPE-OPENPGP",
1691
2336
# Use a fallback default, since this MUST be set.
1692
2337
priority = self.server.gnutls_priority
1693
2338
if priority is None:
1694
2339
priority = "NORMAL"
1695
(gnutls.library.functions
1696
.gnutls_priority_set_direct(session._c_object,
2340
gnutls.priority_set_direct(session,
2341
priority.encode("utf-8"), None)
1699
2343
# Start communication using the Mandos protocol
1700
2344
# Get protocol number
1701
2345
line = self.request.makefile().readline()
1702
logger.debug("Protocol version: %r", line)
2346
log.debug("Protocol version: %r", line)
1704
2348
if int(line.strip().split()[0]) > 1:
1705
2349
raise RuntimeError(line)
1706
2350
except (ValueError, IndexError, RuntimeError) as error:
1707
logger.error("Unknown protocol version: %s", error)
2351
log.error("Unknown protocol version: %s", error)
1710
2354
# Start GnuTLS connection
1712
2356
session.handshake()
1713
except gnutls.errors.GNUTLSError as error:
1714
logger.warning("Handshake failed: %s", error)
2357
except gnutls.Error as error:
2358
log.warning("Handshake failed: %s", error)
1715
2359
# Do not run session.bye() here: the session is not
1716
2360
# established. Just abandon the request.
1718
logger.debug("Handshake succeeded")
2362
log.debug("Handshake succeeded")
1720
2364
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,
2366
if gnutls.has_rawpk:
2369
key_id = self.key_id(
2370
self.peer_certificate(session))
2371
except (TypeError, gnutls.Error) as error:
2372
log.warning("Bad certificate: %s", error)
2374
log.debug("Key ID: %s",
2375
key_id.decode("utf-8",
2381
fpr = self.fingerprint(
2382
self.peer_certificate(session))
2383
except (TypeError, gnutls.Error) as error:
2384
log.warning("Bad certificate: %s", error)
2386
log.debug("Fingerprint: %s", fpr)
2389
client = ProxyClient(child_pipe, key_id, fpr,
1733
2390
self.client_address)
1734
2391
except KeyError:
1737
2394
if client.approval_delay:
1738
2395
delay = client.approval_delay
1739
2396
client.approvals_pending += 1
1740
2397
approval_required = True
1743
2400
if not client.enabled:
1744
logger.info("Client %s is disabled",
2401
log.info("Client %s is disabled", client.name)
1746
2402
if self.server.use_dbus:
1747
2403
# Emit D-Bus signal
1748
2404
client.Rejected("Disabled")
1751
2407
if client.approved or not client.approval_delay:
1752
#We are approved or approval is disabled
2408
# We are approved or approval is disabled
1754
2410
elif client.approved is None:
1755
logger.info("Client %s needs approval",
2411
log.info("Client %s needs approval",
1757
2413
if self.server.use_dbus:
1758
2414
# Emit D-Bus signal
1759
2415
client.NeedApproval(
1760
2416
client.approval_delay.total_seconds()
1761
2417
* 1000, client.approved_by_default)
1763
logger.warning("Client %s was not approved",
2419
log.warning("Client %s was not approved",
1765
2421
if self.server.use_dbus:
1766
2422
# Emit D-Bus signal
1767
2423
client.Rejected("Denied")
1770
#wait until timeout or approved
2426
# wait until timeout or approved
1771
2427
time = datetime.datetime.now()
1772
2428
client.changedstate.acquire()
1773
2429
client.changedstate.wait(delay.total_seconds())
1788
2444
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)
2447
session.send(client.secret)
2448
except gnutls.Error as error:
2449
log.warning("gnutls send failed", exc_info=error)
2452
log.info("Sending secret to %s", client.name)
1804
2453
# bump the timeout using extended_timeout
1805
2454
client.bump_timeout(client.extended_timeout)
1806
2455
if self.server.use_dbus:
1807
2456
# Emit D-Bus signal
1808
2457
client.GotSecret()
1811
2460
if approval_required:
1812
2461
client.approvals_pending -= 1
1815
except gnutls.errors.GNUTLSError as error:
1816
logger.warning("GnuTLS bye failed",
2464
except gnutls.Error as error:
2465
log.warning("GnuTLS bye failed", exc_info=error)
1820
2468
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
2469
"Return the peer's certificate as a bytestring"
2471
cert_type = gnutls.certificate_type_get2(
2472
session, gnutls.CTYPE_PEERS)
2473
except AttributeError:
2474
cert_type = gnutls.certificate_type_get(session)
2475
if gnutls.has_rawpk:
2476
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2478
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2479
# If not a valid certificate type...
2480
if cert_type not in valid_cert_types:
2481
log.info("Cert type %r not in %r", cert_type,
2483
# ...return invalid data
1828
2485
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)))
2486
cert_list = (gnutls.certificate_get_peers
2487
(session, ctypes.byref(list_size)))
1832
2488
if not bool(cert_list) and list_size.value != 0:
1833
raise gnutls.errors.GNUTLSError("error getting peer"
2489
raise gnutls.Error("error getting peer certificate")
1835
2490
if list_size.value == 0:
1837
2492
cert = cert_list[0]
1838
2493
return ctypes.string_at(cert.data, cert.size)
2496
def key_id(certificate):
2497
"Convert a certificate bytestring to a hexdigit key ID"
2498
# New GnuTLS "datum" with the public key
2499
datum = gnutls.datum_t(
2500
ctypes.cast(ctypes.c_char_p(certificate),
2501
ctypes.POINTER(ctypes.c_ubyte)),
2502
ctypes.c_uint(len(certificate)))
2503
# XXX all these need to be created in the gnutls "module"
2504
# New empty GnuTLS certificate
2505
pubkey = gnutls.pubkey_t()
2506
gnutls.pubkey_init(ctypes.byref(pubkey))
2507
# Import the raw public key into the certificate
2508
gnutls.pubkey_import(pubkey,
2509
ctypes.byref(datum),
2510
gnutls.X509_FMT_DER)
2511
# New buffer for the key ID
2512
buf = ctypes.create_string_buffer(32)
2513
buf_len = ctypes.c_size_t(len(buf))
2514
# Get the key ID from the raw public key into the buffer
2515
gnutls.pubkey_get_key_id(
2517
gnutls.KEYID_USE_SHA256,
2518
ctypes.cast(ctypes.byref(buf),
2519
ctypes.POINTER(ctypes.c_ubyte)),
2520
ctypes.byref(buf_len))
2521
# Deinit the certificate
2522
gnutls.pubkey_deinit(pubkey)
2524
# Convert the buffer to a Python bytestring
2525
key_id = ctypes.string_at(buf, buf_len.value)
2526
# Convert the bytestring to hexadecimal notation
2527
hex_key_id = binascii.hexlify(key_id).upper()
1841
2531
def fingerprint(openpgp):
1842
2532
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1843
2533
# 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))))
2534
datum = gnutls.datum_t(
2535
ctypes.cast(ctypes.c_char_p(openpgp),
2536
ctypes.POINTER(ctypes.c_ubyte)),
2537
ctypes.c_uint(len(openpgp)))
1849
2538
# 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)))
2539
crt = gnutls.openpgp_crt_t()
2540
gnutls.openpgp_crt_init(ctypes.byref(crt))
1853
2541
# 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))
2542
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2543
gnutls.OPENPGP_FMT_RAW)
1858
2544
# Verify the self signature in the key
1859
2545
crtverify = ctypes.c_uint()
1860
(gnutls.library.functions
1861
.gnutls_openpgp_crt_verify_self(crt, 0,
1862
ctypes.byref(crtverify)))
2546
gnutls.openpgp_crt_verify_self(crt, 0,
2547
ctypes.byref(crtverify))
1863
2548
if crtverify.value != 0:
1864
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1865
raise (gnutls.errors.CertificateSecurityError
2549
gnutls.openpgp_crt_deinit(crt)
2550
raise gnutls.CertificateSecurityError(code
1867
2552
# New buffer for the fingerprint
1868
2553
buf = ctypes.create_string_buffer(20)
1869
2554
buf_len = ctypes.c_size_t()
1870
2555
# 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)))
2556
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2557
ctypes.byref(buf_len))
1874
2558
# Deinit the certificate
1875
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2559
gnutls.openpgp_crt_deinit(crt)
1876
2560
# Convert the buffer to a Python bytestring
1877
2561
fpr = ctypes.string_at(buf, buf_len.value)
1878
2562
# Convert the bytestring to hexadecimal notation
1961
2651
# socket_wrapper(), if socketfd was set.
1962
2652
socketserver.TCPServer.__init__(self, server_address,
1963
2653
RequestHandlerClass)
1965
2655
def server_bind(self):
1966
2656
"""This overrides the normal server_bind() function
1967
2657
to bind to an interface if one was specified, and also NOT to
1968
2658
bind to an address or port if they were not specified."""
2659
global SO_BINDTODEVICE
1969
2660
if self.interface is not None:
1970
2661
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)
2662
# Fall back to a hard-coded value which seems to be
2664
log.warning("SO_BINDTODEVICE not found, trying 25")
2665
SO_BINDTODEVICE = 25
2667
self.socket.setsockopt(
2668
socket.SOL_SOCKET, SO_BINDTODEVICE,
2669
(self.interface + "\0").encode("utf-8"))
2670
except socket.error as error:
2671
if error.errno == errno.EPERM:
2672
log.error("No permission to bind to interface %s",
2674
elif error.errno == errno.ENOPROTOOPT:
2675
log.error("SO_BINDTODEVICE not available; cannot"
2676
" bind to interface %s", self.interface)
2677
elif error.errno == errno.ENODEV:
2678
log.error("Interface %s does not exist, cannot"
2679
" bind", self.interface)
1993
2682
# Only bind(2) the socket if we really need to.
1994
2683
if self.server_address[0] or self.server_address[1]:
2684
if self.server_address[1]:
2685
self.allow_reuse_address = True
1995
2686
if not self.server_address[0]:
1996
2687
if self.address_family == socket.AF_INET6:
1997
any_address = "::" # in6addr_any
2688
any_address = "::" # in6addr_any
1999
any_address = "0.0.0.0" # INADDR_ANY
2690
any_address = "0.0.0.0" # INADDR_ANY
2000
2691
self.server_address = (any_address,
2001
2692
self.server_address[1])
2002
2693
elif not self.server_address[1]:
2003
self.server_address = (self.server_address[0],
2694
self.server_address = (self.server_address[0], 0)
2005
2695
# if self.interface:
2006
2696
# self.server_address = (self.server_address[0],
2032
2727
self.gnutls_priority = gnutls_priority
2033
2728
IPv6_TCPServer.__init__(self, server_address,
2034
2729
RequestHandlerClass,
2035
interface = interface,
2036
use_ipv6 = use_ipv6,
2037
socketfd = socketfd)
2730
interface=interface,
2038
2734
def server_activate(self):
2039
2735
if self.enabled:
2040
2736
return socketserver.TCPServer.server_activate(self)
2042
2738
def enable(self):
2043
2739
self.enabled = True
2045
2741
def add_pipe(self, parent_pipe, proc):
2046
2742
# 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):
2744
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2745
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2746
functools.partial(self.handle_ipc,
2747
parent_pipe=parent_pipe,
2750
def handle_ipc(self, source, condition,
2753
client_object=None):
2056
2754
# error, or the other end of multiprocessing.Pipe has closed
2057
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2755
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2058
2756
# Wait for other process to exit
2062
2760
# Read a request from the child
2063
2761
request = parent_pipe.recv()
2064
2762
command = request[0]
2066
if command == 'init':
2068
address = request[2]
2070
for c in self.clients.itervalues():
2071
if c.fingerprint == fpr:
2764
if command == "init":
2765
key_id = request[1].decode("ascii")
2766
fpr = request[2].decode("ascii")
2767
address = request[3]
2769
for c in self.clients.values():
2770
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2771
"27AE41E4649B934CA495991B7852B855"):
2773
if key_id and c.key_id == key_id:
2776
if fpr and c.fingerprint == fpr:
2075
logger.info("Client not found for fingerprint: %s, ad"
2076
"dress: %s", fpr, address)
2780
log.info("Client not found for key ID: %s, address:"
2781
" %s", key_id or fpr, address)
2077
2782
if self.use_dbus:
2078
2783
# Emit D-Bus signal
2079
mandos_dbus_service.ClientNotFound(fpr,
2784
mandos_dbus_service.ClientNotFound(key_id or fpr,
2081
2786
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,
2790
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2791
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2792
functools.partial(self.handle_ipc,
2793
parent_pipe=parent_pipe,
2795
client_object=client))
2092
2796
parent_pipe.send(True)
2093
2797
# remove the old hook in favor of the new above hook on
2096
if command == 'funcall':
2800
if command == "funcall":
2097
2801
funcname = request[1]
2098
2802
args = request[2]
2099
2803
kwargs = request[3]
2101
parent_pipe.send(('data', getattr(client_object,
2805
parent_pipe.send(("data", getattr(client_object,
2102
2806
funcname)(*args,
2105
if command == 'getattr':
2809
if command == "getattr":
2106
2810
attrname = request[1]
2107
if callable(client_object.__getattribute__(attrname)):
2108
parent_pipe.send(('function',))
2811
if isinstance(client_object.__getattribute__(attrname),
2812
collections.abc.Callable):
2813
parent_pipe.send(("function", ))
2110
parent_pipe.send(('data', client_object
2111
.__getattribute__(attrname)))
2113
if command == 'setattr':
2816
"data", client_object.__getattribute__(attrname)))
2818
if command == "setattr":
2114
2819
attrname = request[1]
2115
2820
value = request[2]
2116
2821
setattr(client_object, attrname, value)
2121
2826
def rfc3339_duration_to_delta(duration):
2122
2827
"""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)
2829
>>> timedelta = datetime.timedelta
2830
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2832
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2834
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2836
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2838
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2840
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2842
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2140
2847
# Parsing an RFC 3339 duration with regular expressions is not
2141
2848
# possible - there would have to be multiple places for the same
2142
2849
# values, like seconds. The current code, while more esoteric, is
2143
2850
# cleaner without depending on a parsing library. If Python had a
2144
2851
# built-in library for parsing we would use it, but we'd like to
2145
2852
# avoid excessive use of external libraries.
2147
2854
# 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
2855
Token = collections.namedtuple("Token", (
2856
"regexp", # To match token; if "value" is not None, must have
2857
# a "group" containing digits
2858
"value", # datetime.timedelta or None
2859
"followers")) # Tokens valid after this token
2157
2860
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2158
2861
# the "duration" ABNF definition in RFC 3339, Appendix A.
2159
2862
token_end = Token(re.compile(r"$"), None, frozenset())
2160
2863
token_second = Token(re.compile(r"(\d+)S"),
2161
2864
datetime.timedelta(seconds=1),
2162
frozenset((token_end,)))
2865
frozenset((token_end, )))
2163
2866
token_minute = Token(re.compile(r"(\d+)M"),
2164
2867
datetime.timedelta(minutes=1),
2165
2868
frozenset((token_second, token_end)))
3199
log.debug("Did setuid/setgid to %s:%s", uid, gid)
2494
3200
except OSError as error:
3201
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3202
os.strerror(error.errno))
2495
3203
if error.errno != errno.EPERM:
2499
3207
# Enable all possible GnuTLS debugging
2501
3209
# "Use a log level over 10 to enable all debugging options."
2502
3210
# - GnuTLS manual
2503
gnutls.library.functions.gnutls_global_set_log_level(11)
2505
@gnutls.library.types.gnutls_log_func
3211
gnutls.global_set_log_level(11)
2506
3214
def debug_gnutls(level, string):
2507
logger.debug("GnuTLS: %s", string[:-1])
2509
(gnutls.library.functions
2510
.gnutls_global_set_log_function(debug_gnutls))
3215
log.debug("GnuTLS: %s",
3216
string[:-1].decode("utf-8", errors="replace"))
3218
gnutls.global_set_log_function(debug_gnutls)
2512
3220
# Redirect stdin so all checkers get /dev/null
2513
3221
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2514
3222
os.dup2(null, sys.stdin.fileno())
2518
3226
# Need to fork before connecting to D-Bus
2519
3227
if not foreground:
2520
3228
# 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()
3231
if gi.version_info < (3, 10, 2):
3232
# multiprocessing will use threads, so before we use GLib we
3233
# need to inform GLib that threads will be used.
2527
3236
global main_loop
2528
3237
# From the Avahi example code
2529
3238
DBusGMainLoop(set_as_default=True)
2530
main_loop = gobject.MainLoop()
3239
main_loop = GLib.MainLoop()
2531
3240
bus = dbus.SystemBus()
2532
3241
# End of Avahi example code
2535
3244
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)
3247
old_bus_name = dbus.service.BusName(
3248
"se.bsnet.fukt.Mandos", bus,
3250
except dbus.exceptions.DBusException as e:
3251
log.error("Disabling D-Bus:", exc_info=e)
2542
3252
use_dbus = False
2543
3253
server_settings["use_dbus"] = False
2544
3254
tcp_server.use_dbus = False
2546
3256
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)
3257
service = AvahiServiceToSyslog(
3258
name=server_settings["servicename"],
3259
servicetype="_mandos._tcp",
2551
3262
if server_settings["interface"]:
2552
service.interface = (if_nametoindex
2553
(server_settings["interface"]
3263
service.interface = if_nametoindex(
3264
server_settings["interface"].encode("utf-8"))
2556
3266
global multiprocessing_manager
2557
3267
multiprocessing_manager = multiprocessing.Manager()
2559
3269
client_class = Client
2561
client_class = functools.partial(ClientDBus, bus = bus)
3271
client_class = functools.partial(ClientDBus, bus=bus)
2563
3273
client_settings = Client.config_parser(client_config)
2564
3274
old_client_settings = {}
2565
3275
clients_data = {}
2567
3277
# This is used to redirect stdout and stderr for checker processes
2569
wnull = open(os.devnull, "w") # A writable /dev/null
3279
wnull = open(os.devnull, "w") # A writable /dev/null
2570
3280
# Only used if server is running in foreground but not in debug
2572
3282
if debug or not foreground:
2575
3285
# Get client data and settings from last running state.
2576
3286
if server_settings["restore"]:
2578
3288
with open(stored_state_path, "rb") as stored_state:
2579
clients_data, old_client_settings = (pickle.load
3289
if sys.version_info.major == 2:
3290
clients_data, old_client_settings = pickle.load(
3293
bytes_clients_data, bytes_old_client_settings = (
3294
pickle.load(stored_state, encoding="bytes"))
3295
# Fix bytes to strings
3298
clients_data = {(key.decode("utf-8")
3299
if isinstance(key, bytes)
3302
bytes_clients_data.items()}
3303
del bytes_clients_data
3304
for key in clients_data:
3305
value = {(k.decode("utf-8")
3306
if isinstance(k, bytes) else k): v
3308
clients_data[key].items()}
3309
clients_data[key] = value
3311
value["client_structure"] = [
3313
if isinstance(s, bytes)
3315
value["client_structure"]]
3316
# .name, .host, and .checker_command
3317
for k in ("name", "host", "checker_command"):
3318
if isinstance(value[k], bytes):
3319
value[k] = value[k].decode("utf-8")
3320
if "key_id" not in value:
3321
value["key_id"] = ""
3322
elif "fingerprint" not in value:
3323
value["fingerprint"] = ""
3324
# old_client_settings
3326
old_client_settings = {
3327
(key.decode("utf-8")
3328
if isinstance(key, bytes)
3331
bytes_old_client_settings.items()}
3332
del bytes_old_client_settings
3333
# .host and .checker_command
3334
for value in old_client_settings.values():
3335
for attribute in ("host", "checker_command"):
3336
if isinstance(value[attribute], bytes):
3337
value[attribute] = (value[attribute]
2581
3339
os.remove(stored_state_path)
2582
3340
except IOError as e:
2583
3341
if e.errno == errno.ENOENT:
2584
logger.warning("Could not load persistent state: {}"
2585
.format(os.strerror(e.errno)))
3342
log.warning("Could not load persistent state:"
3343
" %s", os.strerror(e.errno))
2587
logger.critical("Could not load persistent state:",
3345
log.critical("Could not load persistent state:",
2590
3348
except EOFError as e:
2591
logger.warning("Could not load persistent state: "
2592
"EOFError:", exc_info=e)
3349
log.warning("Could not load persistent state: EOFError:",
2594
3352
with PGPEngine() as pgp:
2595
3353
for client_name, client in clients_data.items():
2596
3354
# Skip removed clients
2597
3355
if client_name not in client_settings:
2600
3358
# Decide which value to use after restoring saved state.
2601
3359
# We have three different values: Old config file,
2602
3360
# new config file, and saved state.
2660
3414
for client_name in (set(client_settings)
2661
3415
- set(old_client_settings)):
2662
3416
clients_data[client_name] = client_settings[client_name]
2664
3418
# Create all client objects
2665
3419
for client_name, client in clients_data.items():
2666
3420
tcp_server.clients[client_name] = client_class(
2667
name = client_name, settings = client,
2668
server_settings = server_settings)
3423
server_settings=server_settings)
2670
3425
if not tcp_server.clients:
2671
logger.warning("No clients defined")
3426
log.warning("No clients defined")
2673
3428
if not foreground:
2674
3429
if pidfile is not None:
2678
pidfile.write("{}\n".format(pid).encode("utf-8"))
3433
print(pid, file=pidfile)
2679
3434
except IOError:
2680
logger.error("Could not write to file %r with PID %d",
3435
log.error("Could not write to file %r with PID %d",
2683
3438
del pidfilename
2685
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2686
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3440
for termsig in (signal.SIGHUP, signal.SIGTERM):
3441
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3442
lambda: main_loop.quit() and False)
2689
@alternate_dbus_interfaces({"se.recompile.Mandos":
2690
"se.bsnet.fukt.Mandos"})
2691
class MandosDBusService(DBusObjectWithProperties):
3446
@alternate_dbus_interfaces(
3447
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3448
class MandosDBusService(DBusObjectWithObjectManager):
2692
3449
"""A D-Bus proxy object"""
2693
3451
def __init__(self):
2694
3452
dbus.service.Object.__init__(self, bus, "/")
2695
3454
_interface = "se.recompile.Mandos"
2697
@dbus_interface_annotations(_interface)
2699
return { "org.freedesktop.DBus.Property"
2700
".EmitsChangedSignal":
2703
3456
@dbus.service.signal(_interface, signature="o")
2704
3457
def ClientAdded(self, objpath):
2708
3461
@dbus.service.signal(_interface, signature="ss")
2709
def ClientNotFound(self, fingerprint, address):
3462
def ClientNotFound(self, key_id, address):
3466
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2713
3468
@dbus.service.signal(_interface, signature="os")
2714
3469
def ClientRemoved(self, objpath, name):
3473
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2718
3475
@dbus.service.method(_interface, out_signature="ao")
2719
3476
def GetAllClients(self):
2721
return dbus.Array(c.dbus_object_path
2723
tcp_server.clients.itervalues())
3478
return dbus.Array(c.dbus_object_path for c in
3479
tcp_server.clients.values())
3481
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2725
3483
@dbus.service.method(_interface,
2726
3484
out_signature="a{oa{sv}}")
2727
3485
def GetAllClientsWithProperties(self):
2729
3487
return dbus.Dictionary(
2730
{ c.dbus_object_path: c.GetAll("")
2731
for c in tcp_server.clients.itervalues() },
3488
{c.dbus_object_path: c.GetAll(
3489
"se.recompile.Mandos.Client")
3490
for c in tcp_server.clients.values()},
2732
3491
signature="oa{sv}")
2734
3493
@dbus.service.method(_interface, in_signature="o")
2735
3494
def RemoveClient(self, object_path):
2737
for c in tcp_server.clients.itervalues():
3496
for c in tcp_server.clients.values():
2738
3497
if c.dbus_object_path == object_path:
2739
3498
del tcp_server.clients[c.name]
2740
3499
c.remove_from_connection()
2741
# Don't signal anything except ClientRemoved
3500
# Don't signal the disabling
2742
3501
c.disable(quiet=True)
2744
self.ClientRemoved(object_path, c.name)
3502
# Emit D-Bus signal for removal
3503
self.client_removed_signal(c)
2746
3505
raise KeyError(object_path)
3509
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3510
out_signature="a{oa{sa{sv}}}")
3511
def GetManagedObjects(self):
3513
return dbus.Dictionary(
3514
{client.dbus_object_path:
3516
{interface: client.GetAll(interface)
3518
client._get_all_interface_names()})
3519
for client in tcp_server.clients.values()})
3521
def client_added_signal(self, client):
3522
"""Send the new standard signal and the old signal"""
3524
# New standard signal
3525
self.InterfacesAdded(
3526
client.dbus_object_path,
3528
{interface: client.GetAll(interface)
3530
client._get_all_interface_names()}))
3532
self.ClientAdded(client.dbus_object_path)
3534
def client_removed_signal(self, client):
3535
"""Send the new standard signal and the old signal"""
3537
# New standard signal
3538
self.InterfacesRemoved(
3539
client.dbus_object_path,
3540
client._get_all_interface_names())
3542
self.ClientRemoved(client.dbus_object_path,
2750
3545
mandos_dbus_service = MandosDBusService()
3547
# Save modules to variables to exempt the modules from being
3548
# unloaded before the function registered with atexit() is run.
3549
mp = multiprocessing
2753
3553
"Cleanup function; run on exit"
2755
3555
service.cleanup()
2757
multiprocessing.active_children()
3557
mp.active_children()
2759
3559
if not (tcp_server.clients or client_settings):
2762
3562
# Store client before exiting. Secrets are encrypted with key
2763
3563
# based on what config file has. If config file is
2764
3564
# removed/edited, old secret will thus be unrecovable.
2766
3566
with PGPEngine() as pgp:
2767
for client in tcp_server.clients.itervalues():
3567
for client in tcp_server.clients.values():
2768
3568
key = client_settings[client.name]["secret"]
2769
3569
client.encrypted_secret = pgp.encrypt(client.secret,
2771
3571
client_dict = {}
2773
3573
# 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)):
3575
exclude = {"bus", "changedstate", "secret",
3576
"checker", "server_settings"}
3577
for name, typ in inspect.getmembers(dbus.service
2779
3579
exclude.add(name)
2781
3581
client_dict["encrypted_secret"] = (client
2782
3582
.encrypted_secret)
2783
3583
for attr in client.client_structure:
2784
3584
if attr not in exclude:
2785
3585
client_dict[attr] = getattr(client, attr)
2787
3587
clients[client.name] = client_dict
2788
3588
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
3591
with tempfile.NamedTemporaryFile(
3595
dir=os.path.dirname(stored_state_path),
3596
delete=False) as stored_state:
3597
pickle.dump((clients, client_settings), stored_state,
3599
tempname = stored_state.name
2797
3600
os.rename(tempname, stored_state_path)
2798
3601
except (IOError, OSError) as e:
2802
3605
except NameError:
2804
3607
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2805
logger.warning("Could not save persistent state: {}"
2806
.format(os.strerror(e.errno)))
3608
log.warning("Could not save persistent state: %s",
3609
os.strerror(e.errno))
2808
logger.warning("Could not save persistent state:",
3611
log.warning("Could not save persistent state:",
2812
3615
# Delete all clients, and settings from config
2813
3616
while tcp_server.clients:
2814
3617
name, client = tcp_server.clients.popitem()
2816
3619
client.remove_from_connection()
2817
# Don't signal anything except ClientRemoved
3620
# Don't signal the disabling
2818
3621
client.disable(quiet=True)
3622
# Emit D-Bus signal for removal
2821
mandos_dbus_service.ClientRemoved(client
3624
mandos_dbus_service.client_removed_signal(client)
2824
3625
client_settings.clear()
2826
3627
atexit.register(cleanup)
2828
for client in tcp_server.clients.itervalues():
3629
for client in tcp_server.clients.values():
2831
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3631
# Emit D-Bus signal for adding
3632
mandos_dbus_service.client_added_signal(client)
2832
3633
# Need to initiate checking of clients
2833
3634
if client.enabled:
2834
client.init_checker()
3635
client.init_checker(randomize_start=True)
2836
3637
tcp_server.enable()
2837
3638
tcp_server.server_activate()
2839
3640
# Find out what port we got
2841
3642
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())
3644
log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
" 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]
3647
log.info("Now listening on address %r, port %d",
3648
*tcp_server.socket.getsockname())
3650
# service.interface = tcp_server.socket.getsockname()[3]
2854
3654
# From the Avahi example code
2856
3656
service.activate()
2857
3657
except dbus.exceptions.DBusException as error:
2858
logger.critical("D-Bus Exception", exc_info=error)
3658
log.critical("D-Bus Exception", exc_info=error)
2861
3661
# 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")
3664
GLib.IOChannel.unix_new(tcp_server.fileno()),
3665
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3666
lambda *args, **kwargs: (tcp_server.handle_request
3667
(*args[2:], **kwargs) or True))
3669
log.debug("Starting main loop")
2869
3670
main_loop.run()
2870
3671
except AvahiError as error:
2871
logger.critical("Avahi Error", exc_info=error)
3672
log.critical("Avahi Error", exc_info=error)
2874
3675
except KeyboardInterrupt:
2876
3677
print("", file=sys.stderr)
2877
logger.debug("Server received KeyboardInterrupt")
2878
logger.debug("Server exiting")
3678
log.debug("Server received KeyboardInterrupt")
3679
log.debug("Server exiting")
2879
3680
# Must run before the D-Bus bus name gets deregistered
2882
if __name__ == '__main__':
3684
def parse_test_args():
3685
# type: () -> argparse.Namespace
3686
parser = argparse.ArgumentParser(add_help=False)
3687
parser.add_argument("--check", action="store_true")
3688
parser.add_argument("--prefix", )
3689
args, unknown_args = parser.parse_known_args()
3691
# Remove test options from sys.argv
3692
sys.argv[1:] = unknown_args
3695
# Add all tests from doctest strings
3696
def load_tests(loader, tests, none):
3698
tests.addTests(doctest.DocTestSuite())
3701
if __name__ == "__main__":
3702
options = parse_test_args()
3705
extra_test_prefix = options.prefix
3706
if extra_test_prefix is not None:
3707
if not (unittest.main(argv=[""], exit=False)
3708
.result.wasSuccessful()):
3710
class ExtraTestLoader(unittest.TestLoader):
3711
testMethodPrefix = extra_test_prefix
3712
# Call using ./scriptname --test [--verbose]
3713
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3715
unittest.main(argv=[""])
3723
# (lambda (&optional extra)
3724
# (if (not (funcall run-tests-in-test-buffer default-directory
3726
# (funcall show-test-buffer-in-test-window)
3727
# (funcall remove-test-window)
3728
# (if extra (message "Extra tests run successfully!"))))
3729
# run-tests-in-test-buffer:
3730
# (lambda (dir &optional extra)
3731
# (with-current-buffer (get-buffer-create "*Test*")
3732
# (setq buffer-read-only nil
3733
# default-directory dir)
3735
# (compilation-mode))
3736
# (let ((process-result
3737
# (let ((inhibit-read-only t))
3738
# (process-file-shell-command
3739
# (funcall get-command-line extra) nil "*Test*"))))
3740
# (and (numberp process-result)
3741
# (= process-result 0))))
3743
# (lambda (&optional extra)
3744
# (let ((quoted-script
3745
# (shell-quote-argument (funcall get-script-name))))
3747
# (concat "%s --check" (if extra " --prefix=atest" ""))
3751
# (if (fboundp 'file-local-name)
3752
# (file-local-name (buffer-file-name))
3753
# (or (file-remote-p (buffer-file-name) 'localname)
3754
# (buffer-file-name))))
3755
# remove-test-window:
3757
# (let ((test-window (get-buffer-window "*Test*")))
3758
# (if test-window (delete-window test-window))))
3759
# show-test-buffer-in-test-window:
3761
# (when (not (get-buffer-window-list "*Test*"))
3762
# (setq next-error-last-buffer (get-buffer "*Test*"))
3763
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3764
# (display-buffer-overriding-action
3765
# `((display-buffer-in-side-window) (side . ,side)
3766
# (window-height . fit-window-to-buffer)
3767
# (window-width . fit-window-to-buffer))))
3768
# (display-buffer "*Test*"))))
3771
# (let* ((run-extra-tests (lambda () (interactive)
3772
# (funcall run-tests t)))
3773
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3774
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3775
# (setq minor-mode-overriding-map-alist
3776
# (cons `(run-tests . ,outer-keymap)
3777
# minor-mode-overriding-map-alist)))
3778
# (add-hook 'after-save-hook run-tests 90 t))