2
# -*- coding: utf-8; lexical-binding: t -*-
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos server - give out binary blobs to connecting clients.
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
13
13
# Everything else is
14
# Copyright © 2008-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
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27
25
# GNU General Public License for more details.
29
27
# You should have received a copy of the GNU General Public License
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
32
31
# Contact the authors at <mandos@recompile.se>.
34
34
from __future__ import (division, absolute_import, print_function,
38
from future_builtins import *
37
from future_builtins import *
39
import SocketServer as socketserver
48
import SocketServer as socketserver
55
import ConfigParser as configparser
45
import gnutls.connection
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
63
59
import logging.handlers
70
import cPickle as pickle
65
import cPickle as pickle
73
66
import multiprocessing
84
74
import dbus.service
86
from gi.repository import GLib
87
77
from dbus.mainloop.glib import DBusGMainLoop
90
80
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:
122
84
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
85
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
127
87
from IN import SO_BINDTODEVICE
128
88
except ImportError:
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
89
SO_BINDTODEVICE = None
147
92
stored_state_file = "clients.pickle"
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
150
logging.captureWarnings(True) # Show warnings via the logging system
94
logger = logging.getLogger()
95
syslogger = (logging.handlers.SysLogHandler
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
address = str("/dev/log")))
154
if_nametoindex = ctypes.cdll.LoadLibrary(
155
ctypes.util.find_library("c")).if_nametoindex
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
156
103
except (OSError, AttributeError):
158
104
def if_nametoindex(interface):
159
105
"Get an interface index the hard way, i.e. using fcntl()"
160
106
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
161
107
with contextlib.closing(socket.socket()) as s:
162
108
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
163
struct.pack(b"16s16x", interface))
164
interface_index = struct.unpack("I", ifreq[16:20])[0]
109
struct.pack(str("16s16x"),
111
interface_index = struct.unpack(str("I"),
165
113
return interface_index
168
def copy_function(func):
169
"""Make a copy of a function"""
170
if sys.version_info.major == 2:
171
return types.FunctionType(func.func_code,
177
return types.FunctionType(func.__code__,
184
116
def initlogger(debug, level=logging.WARNING):
185
117
"""init logger and add loglevel"""
188
syslogger = (logging.handlers.SysLogHandler(
189
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
191
119
syslogger.setFormatter(logging.Formatter
192
("Mandos [%(process)d]: %(levelname)s:"
194
log.addHandler(syslogger)
120
('Mandos [%(process)d]: %(levelname)s:'
122
logger.addHandler(syslogger)
197
125
console = logging.StreamHandler()
198
console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
202
log.addHandler(console)
126
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
130
logger.addHandler(console)
131
logger.setLevel(level)
206
134
class PGPError(Exception):
255
169
os.rmdir(self.tempdir)
256
170
self.tempdir = None
258
172
def password_encode(self, password):
259
173
# Passphrase can not be empty and can not contain newlines or
260
174
# NUL bytes. So we prefix it and hex encode it.
261
encoded = b"mandos" + binascii.hexlify(password)
262
if len(encoded) > 2048:
263
# GnuPG can't handle long passwords, so encode differently
264
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
265
.replace(b"\n", b"\\n")
266
.replace(b"\0", b"\\x00"))
175
return b"mandos" + binascii.hexlify(password)
269
177
def encrypt(self, data, password):
270
178
passphrase = self.password_encode(password)
271
with tempfile.NamedTemporaryFile(
272
dir=self.tempdir) as passfile:
179
with tempfile.NamedTemporaryFile(dir=self.tempdir
273
181
passfile.write(passphrase)
275
proc = subprocess.Popen([self.gpg, "--symmetric",
183
proc = subprocess.Popen(['gpg', '--symmetric',
278
186
+ self.gnupgargs,
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
187
stdin = subprocess.PIPE,
188
stdout = subprocess.PIPE,
189
stderr = subprocess.PIPE)
190
ciphertext, err = proc.communicate(input = data)
283
191
if proc.returncode != 0:
284
192
raise PGPError(err)
285
193
return ciphertext
287
195
def decrypt(self, data, password):
288
196
passphrase = self.password_encode(password)
289
with tempfile.NamedTemporaryFile(
290
dir=self.tempdir) as passfile:
197
with tempfile.NamedTemporaryFile(dir = self.tempdir
291
199
passfile.write(passphrase)
293
proc = subprocess.Popen([self.gpg, "--decrypt",
201
proc = subprocess.Popen(['gpg', '--decrypt',
296
204
+ self.gnupgargs,
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
205
stdin = subprocess.PIPE,
206
stdout = subprocess.PIPE,
207
stderr = subprocess.PIPE)
208
decrypted_plaintext, err = proc.communicate(input
301
210
if proc.returncode != 0:
302
211
raise PGPError(err)
303
212
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
332
215
class AvahiError(Exception):
333
216
def __init__(self, value, *args, **kwargs):
334
217
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
218
super(AvahiError, self).__init__(value, *args, **kwargs)
219
def __unicode__(self):
220
return unicode(repr(self.value))
339
222
class AvahiServiceError(AvahiError):
343
225
class AvahiGroupError(AvahiError):
229
class AvahiService(object):
348
230
"""An Avahi (Zeroconf) service.
351
233
interface: integer; avahi.IF_UNSPEC or an interface index.
352
234
Used to optionally bind to the specified interface.
353
name: string; Example: "Mandos"
354
type: string; Example: "_mandos._tcp".
235
name: string; Example: 'Mandos'
236
type: string; Example: '_mandos._tcp'.
355
237
See <https://www.iana.org/assignments/service-names-port-numbers>
356
238
port: integer; what port to announce
357
239
TXT: list of strings; TXT record for the service
516
377
follow_name_owner_changes=True),
517
378
avahi.DBUS_INTERFACE_SERVER)
518
379
self.server.connect_to_signal("StateChanged",
519
self.server_state_changed)
380
self.server_state_changed)
520
381
self.server_state_changed(self.server.GetState())
523
384
class AvahiServiceToSyslog(AvahiService):
524
def rename(self, *args, **kwargs):
525
386
"""Add the new name to the syslog messages"""
526
ret = super(AvahiServiceToSyslog, self).rename(*args,
528
syslogger.setFormatter(logging.Formatter(
529
"Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
387
ret = AvahiService.rename(self)
388
syslogger.setFormatter(logging.Formatter
389
('Mandos ({0}) [%(process)d]:'
390
' %(levelname)s: %(message)s'
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))
395
def timedelta_to_milliseconds(td):
396
"Convert a datetime.timedelta() to milliseconds"
397
return ((td.days * 24 * 60 * 60 * 1000)
398
+ (td.seconds * 1000)
399
+ (td.microseconds // 1000))
402
class Client(object):
875
403
"""A representation of a client host served by this server.
878
approved: bool(); None if not yet approved/disapproved
406
approved: bool(); 'None' if not yet approved/disapproved
879
407
approval_delay: datetime.timedelta(); Time to wait for approval
880
408
approval_duration: datetime.timedelta(); Duration of one approval
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
409
checker: subprocess.Popen(); a running checker process used
410
to see if the client lives.
411
'None' if no process is running.
412
checker_callback_tag: a gobject event source tag, or None
885
413
checker_command: string; External command which is run to check
886
414
if client lives. %() expansions are done at
887
415
runtime with vars(self) as dict, so that for
888
416
instance %(name)s can be used in the command.
889
checker_initiator_tag: a GLib event source tag, or None
417
checker_initiator_tag: a gobject event source tag, or None
890
418
created: datetime.datetime(); (UTC) object creation
891
419
client_structure: Object describing what attributes a client has
892
420
and is used for storing the client at exit
893
421
current_checker_command: string; current running checker_command
894
disable_initiator_tag: a GLib event source tag, or None
422
disable_initiator_tag: a gobject event source tag, or None
896
424
fingerprint: string (40 or 32 hexadecimal digits); used to
897
uniquely identify an OpenPGP client
898
key_id: string (64 hexadecimal digits); used to uniquely identify
899
a client using raw public keys
425
uniquely identify the client
900
426
host: string; available for use by the checker command
901
427
interval: datetime.timedelta(); How often to start a new checker
902
428
last_approval_request: datetime.datetime(); (UTC) or None
1023
556
self.current_checker_command = None
1024
557
self.approved = None
1025
558
self.approvals_pending = 0
1026
self.changedstate = multiprocessing_manager.Condition(
1027
multiprocessing_manager.Lock())
1028
self.client_structure = [attr
1029
for attr in self.__dict__.keys()
559
self.changedstate = (multiprocessing_manager
560
.Condition(multiprocessing_manager
562
self.client_structure = [attr for attr in
563
self.__dict__.iterkeys()
1030
564
if not attr.startswith("_")]
1031
565
self.client_structure.append("client_structure")
1033
for name, t in inspect.getmembers(
1034
type(self), lambda obj: isinstance(obj, property)):
567
for name, t in inspect.getmembers(type(self),
1035
571
if not name.startswith("_"):
1036
572
self.client_structure.append(name)
1038
574
# Send notice to process children that client state has changed
1039
575
def send_changedstate(self):
1040
576
with self.changedstate:
1041
577
self.changedstate.notify_all()
1043
579
def enable(self):
1044
580
"""Start this client's checker and timeout hooks"""
1045
581
if getattr(self, "enabled", False):
1046
582
# Already enabled
584
self.expires = datetime.datetime.utcnow() + self.timeout
1048
585
self.enabled = True
1049
586
self.last_enabled = datetime.datetime.utcnow()
1050
587
self.init_checker()
1051
588
self.send_changedstate()
1053
590
def disable(self, quiet=True):
1054
591
"""Disable this client."""
1055
592
if not getattr(self, "enabled", False):
1058
log.info("Disabling client %s", self.name)
595
logger.info("Disabling client %s", self.name)
1059
596
if getattr(self, "disable_initiator_tag", None) is not None:
1060
GLib.source_remove(self.disable_initiator_tag)
597
gobject.source_remove(self.disable_initiator_tag)
1061
598
self.disable_initiator_tag = None
1062
599
self.expires = None
1063
600
if getattr(self, "checker_initiator_tag", None) is not None:
1064
GLib.source_remove(self.checker_initiator_tag)
601
gobject.source_remove(self.checker_initiator_tag)
1065
602
self.checker_initiator_tag = None
1066
603
self.stop_checker()
1067
604
self.enabled = False
1069
606
self.send_changedstate()
1070
# Do not run this again if called by a GLib.timeout_add
607
# Do not run this again if called by a gobject.timeout_add
1073
610
def __del__(self):
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
613
def init_checker(self):
614
# Schedule a new checker to be started an 'interval' from now,
615
# and every interval from then on.
1081
616
if self.checker_initiator_tag is not None:
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
617
gobject.source_remove(self.checker_initiator_tag)
618
self.checker_initiator_tag = (gobject.timeout_add
619
(self.interval_milliseconds(),
621
# Schedule a disable() when 'timeout' has passed
1100
622
if self.disable_initiator_tag is not None:
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,
623
gobject.source_remove(self.disable_initiator_tag)
624
self.disable_initiator_tag = (gobject.timeout_add
625
(self.timeout_milliseconds(),
627
# Also start a new checker *right now*.
630
def checker_callback(self, pid, condition, command):
1108
631
"""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:
1114
632
self.checker_callback_tag = None
1115
633
self.checker = None
1118
self.last_checker_status = returncode
1119
self.last_checker_signal = None
634
if os.WIFEXITED(condition):
635
self.last_checker_status = os.WEXITSTATUS(condition)
1120
636
if self.last_checker_status == 0:
1121
log.info("Checker for %(name)s succeeded", vars(self))
637
logger.info("Checker for %(name)s succeeded",
1122
639
self.checked_ok()
1124
log.info("Checker for %(name)s failed", vars(self))
641
logger.info("Checker for %(name)s failed",
1126
644
self.last_checker_status = -1
1127
self.last_checker_signal = -returncode
1128
log.warning("Checker for %(name)s crashed?", vars(self))
645
logger.warning("Checker for %(name)s crashed?",
1131
648
def checked_ok(self):
1132
649
"""Assert that the client has been seen, alive and well."""
1133
650
self.last_checked_ok = datetime.datetime.utcnow()
1134
651
self.last_checker_status = 0
1135
self.last_checker_signal = None
1136
652
self.bump_timeout()
1138
654
def bump_timeout(self, timeout=None):
1139
655
"""Bump up the timeout for this client."""
1140
656
if timeout is None:
1141
657
timeout = self.timeout
1142
658
if self.disable_initiator_tag is not None:
1143
GLib.source_remove(self.disable_initiator_tag)
659
gobject.source_remove(self.disable_initiator_tag)
1144
660
self.disable_initiator_tag = None
1145
661
if getattr(self, "enabled", False):
1146
self.disable_initiator_tag = GLib.timeout_add(
1147
int(timeout.total_seconds() * 1000), self.disable)
662
self.disable_initiator_tag = (gobject.timeout_add
663
(timedelta_to_milliseconds
664
(timeout), self.disable))
1148
665
self.expires = datetime.datetime.utcnow() + timeout
1150
667
def need_approval(self):
1151
668
self.last_approval_request = datetime.datetime.utcnow()
1153
def start_checker(self, start_was_randomized=False):
670
def start_checker(self):
1154
671
"""Start a new checker subprocess if one is not running.
1156
673
If a checker already exists, leave it running and do
1158
675
# The reason for not killing a running checker is that if we
1163
680
# checkers alone, the checker would have to take more time
1164
681
# than 'timeout' for the client to be disabled, which is as it
1167
if self.checker is not None and not self.checker.is_alive():
1168
log.warning("Checker was not alive; joining")
684
# If a checker exists, make sure it is not a zombie
686
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
687
except (AttributeError, OSError) as error:
688
if (isinstance(error, OSError)
689
and error.errno != errno.ECHILD):
693
logger.warning("Checker was a zombie")
694
gobject.source_remove(self.checker_callback_tag)
695
self.checker_callback(pid, status,
696
self.current_checker_command)
1171
697
# Start a new checker if needed
1172
698
if self.checker is None:
1173
699
# Escape attributes for the shell
1175
attr: shlex.quote(str(getattr(self, attr)))
1176
for attr in self.runtime_expansions}
700
escaped_attrs = dict(
701
(attr, re.escape(unicode(getattr(self, attr))))
703
self.runtime_expansions)
1178
705
command = self.checker_command % escaped_attrs
1179
706
except TypeError as error:
1180
log.error('Could not format string "%s"',
1181
self.checker_command, exc_info=error)
1182
return True # Try again later
707
logger.error('Could not format string "%s"',
708
self.checker_command, exc_info=error)
709
return True # Try again later
1183
710
self.current_checker_command = command
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
712
logger.info("Starting checker %r for %s",
714
# We don't need to redirect stdout and stderr, since
715
# in normal mode, that is already done by daemon(),
716
# and in debug mode we don't want to. (Stdin is
717
# always replaced by /dev/null.)
718
# The exception is when not debugging but nevertheless
719
# running in the foreground; use the previously
722
if (not self.server_settings["debug"]
723
and self.server_settings["foreground"]):
724
popen_args.update({"stdout": wnull,
726
self.checker = subprocess.Popen(command,
730
except OSError as error:
731
logger.error("Failed to start subprocess",
734
self.checker_callback_tag = (gobject.child_watch_add
736
self.checker_callback,
738
# The checker may have completed before the gobject
739
# watch was added. Check for this.
741
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
742
except OSError as error:
743
if error.errno == errno.ECHILD:
744
# This should never happen
745
logger.error("Child process vanished",
750
gobject.source_remove(self.checker_callback_tag)
751
self.checker_callback(pid, status, command)
752
# Re-run this periodically if run by gobject.timeout_add
1223
755
def stop_checker(self):
1224
756
"""Force the checker process, if any, to stop."""
1225
757
if self.checker_callback_tag:
1226
GLib.source_remove(self.checker_callback_tag)
758
gobject.source_remove(self.checker_callback_tag)
1227
759
self.checker_callback_tag = None
1228
760
if getattr(self, "checker", None) is None:
1230
log.debug("Stopping checker for %(name)s", vars(self))
1231
self.checker.terminate()
762
logger.debug("Stopping checker for %(name)s", vars(self))
764
self.checker.terminate()
766
#if self.checker.poll() is None:
767
# self.checker.kill()
768
except OSError as error:
769
if error.errno != errno.ESRCH: # No such process
1232
771
self.checker = None
1235
def dbus_service_property(dbus_interface,
774
def dbus_service_property(dbus_interface, signature="v",
775
access="readwrite", byte_arrays=False):
1239
776
"""Decorators for marking methods of a DBusObjectWithProperties to
1240
777
become properties on the D-Bus.
1242
779
The decorated method will be called with no arguments by "Get"
1243
780
and with one argument by "Set".
1245
782
The parameters, where they are supported, are the same as
1246
783
dbus.service.method, except there is only "signature", since the
1247
784
type from Get() and the type sent to Set() is the same.
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.
860
class DBusObjectWithProperties(dbus.service.Object):
861
"""A D-Bus object with properties.
863
Classes inheriting from this can use the dbus_service_property
864
decorator to expose methods as D-Bus properties. It exposes the
865
standard Get(), Set(), and GetAll() methods on the D-Bus.
1338
869
def _is_dbus_thing(thing):
1339
870
"""Returns a function testing if an attribute is a D-Bus thing
1341
872
If called like _is_dbus_thing("method") it returns a function
1342
873
suitable for use as predicate to inspect.getmembers().
1344
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
875
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1347
878
def _get_all_dbus_things(self, thing):
1348
879
"""Returns a generator of (name, attribute) pairs
1350
return ((getattr(athing.__get__(self), "_dbus_name", name),
881
return ((getattr(athing.__get__(self), "_dbus_name",
1351
883
athing.__get__(self))
1352
884
for cls in self.__class__.__mro__
1353
885
for name, athing in
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.
886
inspect.getmembers(cls,
887
self._is_dbus_thing(thing)))
1427
889
def _get_dbus_property(self, interface_name, property_name):
1428
890
"""Returns a bound method if one exists which is a D-Bus
1429
891
property with the specified name and interface.
1431
for cls in self.__class__.__mro__:
1432
for name, value in inspect.getmembers(
1433
cls, self._is_dbus_thing("property")):
893
for cls in self.__class__.__mro__:
894
for name, value in (inspect.getmembers
896
self._is_dbus_thing("property"))):
1434
897
if (value._dbus_name == property_name
1435
898
and value._dbus_interface == interface_name):
1436
899
return value.__get__(self)
1438
901
# No such property
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,
902
raise DBusPropertyNotFound(self.dbus_object_path + ":"
903
+ interface_name + "."
906
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1453
907
out_signature="v")
1454
908
def Get(self, interface_name, property_name):
1455
909
"""Standard D-Bus property Get() method, see D-Bus standard.
1578
1034
document.unlink()
1579
1035
except (AttributeError, xml.dom.DOMException,
1580
1036
xml.parsers.expat.ExpatError) as error:
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",
1037
logger.error("Failed to override Introspection method",
1654
1039
return xmlstring
1657
1042
def datetime_to_dbus(dt, variant_level=0):
1658
1043
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1660
return dbus.String("", variant_level=variant_level)
1661
return dbus.String(dt.isoformat(), variant_level=variant_level)
1045
return dbus.String("", variant_level = variant_level)
1046
return dbus.String(dt.isoformat(),
1047
variant_level=variant_level)
1664
1050
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
2025
1403
server to mandos-client
2029
1407
# Rejected - signal
2030
1408
@dbus.service.signal(_interface, signature="s")
2031
1409
def Rejected(self, reason):
2035
1413
# NeedApproval - signal
2036
1414
@dbus.service.signal(_interface, signature="tb")
2037
1415
def NeedApproval(self, timeout, default):
2039
1417
return self.need_approval()
2043
1421
# Approve - method
2044
1422
@dbus.service.method(_interface, in_signature="b")
2045
1423
def Approve(self, value):
2046
1424
self.approve(value)
2048
1426
# CheckedOK - method
2049
1427
@dbus.service.method(_interface)
2050
1428
def CheckedOK(self):
2051
1429
self.checked_ok()
2053
1431
# Enable - method
2054
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2055
1432
@dbus.service.method(_interface)
2056
1433
def Enable(self):
2060
1437
# StartChecker - method
2061
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2062
1438
@dbus.service.method(_interface)
2063
1439
def StartChecker(self):
2065
1441
self.start_checker()
2067
1443
# Disable - method
2068
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2069
1444
@dbus.service.method(_interface)
2070
1445
def Disable(self):
2074
1449
# StopChecker - method
2075
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2076
1450
@dbus.service.method(_interface)
2077
1451
def StopChecker(self):
2078
1452
self.stop_checker()
2082
1456
# ApprovalPending - property
2083
1457
@dbus_service_property(_interface, signature="b", access="read")
2084
1458
def ApprovalPending_dbus_property(self):
2085
1459
return dbus.Boolean(bool(self.approvals_pending))
2087
1461
# ApprovedByDefault - property
2088
@dbus_service_property(_interface,
1462
@dbus_service_property(_interface, signature="b",
2090
1463
access="readwrite")
2091
1464
def ApprovedByDefault_dbus_property(self, value=None):
2092
1465
if value is None: # get
2093
1466
return dbus.Boolean(self.approved_by_default)
2094
1467
self.approved_by_default = bool(value)
2096
1469
# ApprovalDelay - property
2097
@dbus_service_property(_interface,
1470
@dbus_service_property(_interface, signature="t",
2099
1471
access="readwrite")
2100
1472
def ApprovalDelay_dbus_property(self, value=None):
2101
1473
if value is None: # get
2102
return dbus.UInt64(self.approval_delay.total_seconds()
1474
return dbus.UInt64(self.approval_delay_milliseconds())
2104
1475
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2106
1477
# ApprovalDuration - property
2107
@dbus_service_property(_interface,
1478
@dbus_service_property(_interface, signature="t",
2109
1479
access="readwrite")
2110
1480
def ApprovalDuration_dbus_property(self, value=None):
2111
1481
if value is None: # get
2112
return dbus.UInt64(self.approval_duration.total_seconds()
1482
return dbus.UInt64(timedelta_to_milliseconds(
1483
self.approval_duration))
2114
1484
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2116
1486
# Name - property
2118
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2119
1487
@dbus_service_property(_interface, signature="s", access="read")
2120
1488
def Name_dbus_property(self):
2121
1489
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)
2130
1491
# Fingerprint - property
2132
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2133
1492
@dbus_service_property(_interface, signature="s", access="read")
2134
1493
def Fingerprint_dbus_property(self):
2135
1494
return dbus.String(self.fingerprint)
2137
1496
# Host - property
2138
@dbus_service_property(_interface,
1497
@dbus_service_property(_interface, signature="s",
2140
1498
access="readwrite")
2141
1499
def Host_dbus_property(self, value=None):
2142
1500
if value is None: # get
2143
1501
return dbus.String(self.host)
2144
self.host = str(value)
1502
self.host = unicode(value)
2146
1504
# Created - property
2148
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2149
1505
@dbus_service_property(_interface, signature="s", access="read")
2150
1506
def Created_dbus_property(self):
2151
1507
return datetime_to_dbus(self.created)
2153
1509
# LastEnabled - property
2154
1510
@dbus_service_property(_interface, signature="s", access="read")
2155
1511
def LastEnabled_dbus_property(self):
2156
1512
return datetime_to_dbus(self.last_enabled)
2158
1514
# Enabled - property
2159
@dbus_service_property(_interface,
1515
@dbus_service_property(_interface, signature="b",
2161
1516
access="readwrite")
2162
1517
def Enabled_dbus_property(self, value=None):
2163
1518
if value is None: # get
2264
1614
self.start_checker()
2266
1616
self.stop_checker()
2268
1618
# ObjectPath - property
2270
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2271
"org.freedesktop.DBus.Deprecated": "true"})
2272
1619
@dbus_service_property(_interface, signature="o", access="read")
2273
1620
def ObjectPath_dbus_property(self):
2274
return self.dbus_object_path # is already a dbus.ObjectPath
1621
return self.dbus_object_path # is already a dbus.ObjectPath
2276
1623
# Secret = property
2278
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2280
@dbus_service_property(_interface,
1624
@dbus_service_property(_interface, signature="ay",
1625
access="write", byte_arrays=True)
2284
1626
def Secret_dbus_property(self, value):
2285
self.secret = bytes(value)
1627
self.secret = str(value)
2291
def __init__(self, child_pipe, key_id, fpr, address):
1632
class ProxyClient(object):
1633
def __init__(self, child_pipe, fpr, address):
2292
1634
self._pipe = child_pipe
2293
self._pipe.send(("init", key_id, fpr, address))
1635
self._pipe.send(('init', fpr, address))
2294
1636
if not self._pipe.recv():
2295
raise KeyError(key_id or fpr)
2297
1639
def __getattribute__(self, name):
2299
1641
return super(ProxyClient, self).__getattribute__(name)
2300
self._pipe.send(("getattr", name))
1642
self._pipe.send(('getattr', name))
2301
1643
data = self._pipe.recv()
2302
if data[0] == "data":
1644
if data[0] == 'data':
2304
if data[0] == "function":
1646
if data[0] == 'function':
2306
1647
def func(*args, **kwargs):
2307
self._pipe.send(("funcall", name, args, kwargs))
1648
self._pipe.send(('funcall', name, args, kwargs))
2308
1649
return self._pipe.recv()[1]
2312
1652
def __setattr__(self, name, value):
2314
1654
return super(ProxyClient, self).__setattr__(name, value)
2315
self._pipe.send(("setattr", name, value))
1655
self._pipe.send(('setattr', name, value))
2318
1658
class ClientHandler(socketserver.BaseRequestHandler, object):
2319
1659
"""A class to handle client connections.
2321
1661
Instantiated once for each connection to handle it.
2322
1662
Note: This will run in its own forked process."""
2324
1664
def handle(self):
2325
1665
with contextlib.closing(self.server.child_pipe) as child_pipe:
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",
1666
logger.info("TCP connection from: %s",
1667
unicode(self.client_address))
1668
logger.debug("Pipe FD: %d",
1669
self.server.child_pipe.fileno())
1671
session = (gnutls.connection
1672
.ClientSession(self.request,
1674
.X509Credentials()))
1676
# Note: gnutls.connection.X509Credentials is really a
1677
# generic GnuTLS certificate credentials object so long as
1678
# no X.509 keys are added to it. Therefore, we can use it
1679
# here despite using OpenPGP certificates.
1681
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1682
# "+AES-256-CBC", "+SHA1",
1683
# "+COMP-NULL", "+CTYPE-OPENPGP",
2336
1685
# Use a fallback default, since this MUST be set.
2337
1686
priority = self.server.gnutls_priority
2338
1687
if priority is None:
2339
1688
priority = "NORMAL"
2340
gnutls.priority_set_direct(session,
2341
priority.encode("utf-8"), None)
1689
(gnutls.library.functions
1690
.gnutls_priority_set_direct(session._c_object,
2343
1693
# Start communication using the Mandos protocol
2344
1694
# Get protocol number
2345
1695
line = self.request.makefile().readline()
2346
log.debug("Protocol version: %r", line)
1696
logger.debug("Protocol version: %r", line)
2348
1698
if int(line.strip().split()[0]) > 1:
2349
raise RuntimeError(line)
2350
1700
except (ValueError, IndexError, RuntimeError) as error:
2351
log.error("Unknown protocol version: %s", error)
1701
logger.error("Unknown protocol version: %s", error)
2354
1704
# Start GnuTLS connection
2356
1706
session.handshake()
2357
except gnutls.Error as error:
2358
log.warning("Handshake failed: %s", error)
1707
except gnutls.errors.GNUTLSError as error:
1708
logger.warning("Handshake failed: %s", error)
2359
1709
# Do not run session.bye() here: the session is not
2360
1710
# established. Just abandon the request.
2362
log.debug("Handshake succeeded")
1712
logger.debug("Handshake succeeded")
2364
1714
approval_required = False
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,
1717
fpr = self.fingerprint(self.peer_certificate
1720
gnutls.errors.GNUTLSError) as error:
1721
logger.warning("Bad certificate: %s", error)
1723
logger.debug("Fingerprint: %s", fpr)
1726
client = ProxyClient(child_pipe, fpr,
2390
1727
self.client_address)
2391
1728
except KeyError:
2394
1731
if client.approval_delay:
2395
1732
delay = client.approval_delay
2396
1733
client.approvals_pending += 1
2397
1734
approval_required = True
2400
1737
if not client.enabled:
2401
log.info("Client %s is disabled", client.name)
1738
logger.info("Client %s is disabled",
2402
1740
if self.server.use_dbus:
2403
1741
# Emit D-Bus signal
2404
1742
client.Rejected("Disabled")
2407
1745
if client.approved or not client.approval_delay:
2408
# We are approved or approval is disabled
1746
#We are approved or approval is disabled
2410
1748
elif client.approved is None:
2411
log.info("Client %s needs approval",
1749
logger.info("Client %s needs approval",
2413
1751
if self.server.use_dbus:
2414
1752
# Emit D-Bus signal
2415
1753
client.NeedApproval(
2416
client.approval_delay.total_seconds()
2417
* 1000, client.approved_by_default)
1754
client.approval_delay_milliseconds(),
1755
client.approved_by_default)
2419
log.warning("Client %s was not approved",
1757
logger.warning("Client %s was not approved",
2421
1759
if self.server.use_dbus:
2422
1760
# Emit D-Bus signal
2423
1761
client.Rejected("Denied")
2426
# wait until timeout or approved
1764
#wait until timeout or approved
2427
1765
time = datetime.datetime.now()
2428
1766
client.changedstate.acquire()
2429
client.changedstate.wait(delay.total_seconds())
1767
client.changedstate.wait(
1768
float(timedelta_to_milliseconds(delay)
2430
1770
client.changedstate.release()
2431
1771
time2 = datetime.datetime.now()
2432
1772
if (time2 - time) >= delay:
2433
1773
if not client.approved_by_default:
2434
log.warning("Client %s timed out while"
2435
" waiting for approval",
1774
logger.warning("Client %s timed out while"
1775
" waiting for approval",
2437
1777
if self.server.use_dbus:
2438
1778
# Emit D-Bus signal
2439
1779
client.Rejected("Approval timed out")
2444
1784
delay -= time2 - time
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)
1787
while sent_size < len(client.secret):
1789
sent = session.send(client.secret[sent_size:])
1790
except gnutls.errors.GNUTLSError as error:
1791
logger.warning("gnutls send failed",
1794
logger.debug("Sent: %d, remaining: %d",
1795
sent, len(client.secret)
1796
- (sent_size + sent))
1799
logger.info("Sending secret to %s", client.name)
2453
1800
# bump the timeout using extended_timeout
2454
1801
client.bump_timeout(client.extended_timeout)
2455
1802
if self.server.use_dbus:
2456
1803
# Emit D-Bus signal
2457
1804
client.GotSecret()
2460
1807
if approval_required:
2461
1808
client.approvals_pending -= 1
2464
except gnutls.Error as error:
2465
log.warning("GnuTLS bye failed", exc_info=error)
1811
except gnutls.errors.GNUTLSError as error:
1812
logger.warning("GnuTLS bye failed",
2468
1816
def peer_certificate(session):
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
1817
"Return the peer's OpenPGP certificate as a bytestring"
1818
# If not an OpenPGP certificate...
1819
if (gnutls.library.functions
1820
.gnutls_certificate_type_get(session._c_object)
1821
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1822
# ...do the normal thing
1823
return session.peer_certificate
2485
1824
list_size = ctypes.c_uint(1)
2486
cert_list = (gnutls.certificate_get_peers
2487
(session, ctypes.byref(list_size)))
1825
cert_list = (gnutls.library.functions
1826
.gnutls_certificate_get_peers
1827
(session._c_object, ctypes.byref(list_size)))
2488
1828
if not bool(cert_list) and list_size.value != 0:
2489
raise gnutls.Error("error getting peer certificate")
1829
raise gnutls.errors.GNUTLSError("error getting peer"
2490
1831
if list_size.value == 0:
2492
1833
cert = cert_list[0]
2493
1834
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()
2531
1837
def fingerprint(openpgp):
2532
1838
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2533
1839
# New GnuTLS "datum" with the OpenPGP public key
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)))
1840
datum = (gnutls.library.types
1841
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1844
ctypes.c_uint(len(openpgp))))
2538
1845
# New empty GnuTLS certificate
2539
crt = gnutls.openpgp_crt_t()
2540
gnutls.openpgp_crt_init(ctypes.byref(crt))
1846
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1847
(gnutls.library.functions
1848
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2541
1849
# Import the OpenPGP public key into the certificate
2542
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2543
gnutls.OPENPGP_FMT_RAW)
1850
(gnutls.library.functions
1851
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1852
gnutls.library.constants
1853
.GNUTLS_OPENPGP_FMT_RAW))
2544
1854
# Verify the self signature in the key
2545
1855
crtverify = ctypes.c_uint()
2546
gnutls.openpgp_crt_verify_self(crt, 0,
2547
ctypes.byref(crtverify))
1856
(gnutls.library.functions
1857
.gnutls_openpgp_crt_verify_self(crt, 0,
1858
ctypes.byref(crtverify)))
2548
1859
if crtverify.value != 0:
2549
gnutls.openpgp_crt_deinit(crt)
2550
raise gnutls.CertificateSecurityError(code
1860
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1861
raise (gnutls.errors.CertificateSecurityError
2552
1863
# New buffer for the fingerprint
2553
1864
buf = ctypes.create_string_buffer(20)
2554
1865
buf_len = ctypes.c_size_t()
2555
1866
# Get the fingerprint from the certificate into the buffer
2556
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2557
ctypes.byref(buf_len))
1867
(gnutls.library.functions
1868
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1869
ctypes.byref(buf_len)))
2558
1870
# Deinit the certificate
2559
gnutls.openpgp_crt_deinit(crt)
1871
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2560
1872
# Convert the buffer to a Python bytestring
2561
1873
fpr = ctypes.string_at(buf, buf_len.value)
2562
1874
# Convert the bytestring to hexadecimal notation
2651
1957
# socket_wrapper(), if socketfd was set.
2652
1958
socketserver.TCPServer.__init__(self, server_address,
2653
1959
RequestHandlerClass)
2655
1961
def server_bind(self):
2656
1962
"""This overrides the normal server_bind() function
2657
1963
to bind to an interface if one was specified, and also NOT to
2658
1964
bind to an address or port if they were not specified."""
2659
global SO_BINDTODEVICE
2660
1965
if self.interface is not None:
2661
1966
if SO_BINDTODEVICE is None:
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)
1967
logger.error("SO_BINDTODEVICE does not exist;"
1968
" cannot bind to interface %s",
1972
self.socket.setsockopt(socket.SOL_SOCKET,
1974
str(self.interface + '\0'))
1975
except socket.error as error:
1976
if error.errno == errno.EPERM:
1977
logger.error("No permission to bind to"
1978
" interface %s", self.interface)
1979
elif error.errno == errno.ENOPROTOOPT:
1980
logger.error("SO_BINDTODEVICE not available;"
1981
" cannot bind to interface %s",
1983
elif error.errno == errno.ENODEV:
1984
logger.error("Interface %s does not exist,"
1985
" cannot bind", self.interface)
2682
1988
# Only bind(2) the socket if we really need to.
2683
1989
if self.server_address[0] or self.server_address[1]:
2684
if self.server_address[1]:
2685
self.allow_reuse_address = True
2686
1990
if not self.server_address[0]:
2687
1991
if self.address_family == socket.AF_INET6:
2688
any_address = "::" # in6addr_any
1992
any_address = "::" # in6addr_any
2690
any_address = "0.0.0.0" # INADDR_ANY
1994
any_address = "0.0.0.0" # INADDR_ANY
2691
1995
self.server_address = (any_address,
2692
1996
self.server_address[1])
2693
1997
elif not self.server_address[1]:
2694
self.server_address = (self.server_address[0], 0)
1998
self.server_address = (self.server_address[0],
2695
2000
# if self.interface:
2696
2001
# self.server_address = (self.server_address[0],
2727
2027
self.gnutls_priority = gnutls_priority
2728
2028
IPv6_TCPServer.__init__(self, server_address,
2729
2029
RequestHandlerClass,
2730
interface=interface,
2030
interface = interface,
2031
use_ipv6 = use_ipv6,
2032
socketfd = socketfd)
2734
2033
def server_activate(self):
2735
2034
if self.enabled:
2736
2035
return socketserver.TCPServer.server_activate(self)
2738
2037
def enable(self):
2739
2038
self.enabled = True
2741
2040
def add_pipe(self, parent_pipe, proc):
2742
2041
# Call "handle_ipc" for both data and EOF events
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):
2042
gobject.io_add_watch(parent_pipe.fileno(),
2043
gobject.IO_IN | gobject.IO_HUP,
2044
functools.partial(self.handle_ipc,
2049
def handle_ipc(self, source, condition, parent_pipe=None,
2050
proc = None, client_object=None):
2754
2051
# error, or the other end of multiprocessing.Pipe has closed
2755
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2052
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2756
2053
# Wait for other process to exit
2760
2057
# Read a request from the child
2761
2058
request = parent_pipe.recv()
2762
2059
command = request[0]
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:
2061
if command == 'init':
2063
address = request[2]
2065
for c in self.clients.itervalues():
2066
if c.fingerprint == fpr:
2780
log.info("Client not found for key ID: %s, address:"
2781
" %s", key_id or fpr, address)
2070
logger.info("Client not found for fingerprint: %s, ad"
2071
"dress: %s", fpr, address)
2782
2072
if self.use_dbus:
2783
2073
# Emit D-Bus signal
2784
mandos_dbus_service.ClientNotFound(key_id or fpr,
2074
mandos_dbus_service.ClientNotFound(fpr,
2786
2076
parent_pipe.send(False)
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))
2079
gobject.io_add_watch(parent_pipe.fileno(),
2080
gobject.IO_IN | gobject.IO_HUP,
2081
functools.partial(self.handle_ipc,
2796
2087
parent_pipe.send(True)
2797
2088
# remove the old hook in favor of the new above hook on
2800
if command == "funcall":
2091
if command == 'funcall':
2801
2092
funcname = request[1]
2802
2093
args = request[2]
2803
2094
kwargs = request[3]
2805
parent_pipe.send(("data", getattr(client_object,
2096
parent_pipe.send(('data', getattr(client_object,
2806
2097
funcname)(*args,
2809
if command == "getattr":
2100
if command == 'getattr':
2810
2101
attrname = request[1]
2811
if isinstance(client_object.__getattribute__(attrname),
2812
collections.abc.Callable):
2813
parent_pipe.send(("function", ))
2102
if callable(client_object.__getattribute__(attrname)):
2103
parent_pipe.send(('function',))
2816
"data", client_object.__getattribute__(attrname)))
2818
if command == "setattr":
2105
parent_pipe.send(('data', client_object
2106
.__getattribute__(attrname)))
2108
if command == 'setattr':
2819
2109
attrname = request[1]
2820
2110
value = request[2]
2821
2111
setattr(client_object, attrname, value)
2826
2116
def rfc3339_duration_to_delta(duration):
2827
2117
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
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)
2119
>>> rfc3339_duration_to_delta("P7D")
2120
datetime.timedelta(7)
2121
>>> rfc3339_duration_to_delta("PT60S")
2122
datetime.timedelta(0, 60)
2123
>>> rfc3339_duration_to_delta("PT60M")
2124
datetime.timedelta(0, 3600)
2125
>>> rfc3339_duration_to_delta("PT24H")
2126
datetime.timedelta(1)
2127
>>> rfc3339_duration_to_delta("P1W")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT5M30S")
2130
datetime.timedelta(0, 330)
2131
>>> rfc3339_duration_to_delta("P1DT3M20S")
2132
datetime.timedelta(1, 200)
2847
2135
# Parsing an RFC 3339 duration with regular expressions is not
2848
2136
# possible - there would have to be multiple places for the same
2849
2137
# values, like seconds. The current code, while more esoteric, is
2850
2138
# cleaner without depending on a parsing library. If Python had a
2851
2139
# built-in library for parsing we would use it, but we'd like to
2852
2140
# avoid excessive use of external libraries.
2854
2142
# New type for defining tokens, syntax, and semantics all-in-one
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
2143
Token = collections.namedtuple("Token",
2144
("regexp", # To match token; if
2145
# "value" is not None,
2146
# must have a "group"
2148
"value", # datetime.timedelta or
2150
"followers")) # Tokens valid after
2860
2152
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2861
2153
# the "duration" ABNF definition in RFC 3339, Appendix A.
2862
2154
token_end = Token(re.compile(r"$"), None, frozenset())
2863
2155
token_second = Token(re.compile(r"(\d+)S"),
2864
2156
datetime.timedelta(seconds=1),
2865
frozenset((token_end, )))
2157
frozenset((token_end,)))
2866
2158
token_minute = Token(re.compile(r"(\d+)M"),
2867
2159
datetime.timedelta(minutes=1),
2868
2160
frozenset((token_second, token_end)))
3199
log.debug("Did setuid/setgid to %s:%s", uid, gid)
3200
2474
except OSError as error:
3201
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3202
os.strerror(error.errno))
3203
2475
if error.errno != errno.EPERM:
3207
2479
# Enable all possible GnuTLS debugging
3209
2481
# "Use a log level over 10 to enable all debugging options."
3210
2482
# - GnuTLS manual
3211
gnutls.global_set_log_level(11)
2483
gnutls.library.functions.gnutls_global_set_log_level(11)
2485
@gnutls.library.types.gnutls_log_func
3214
2486
def debug_gnutls(level, string):
3215
log.debug("GnuTLS: %s",
3216
string[:-1].decode("utf-8", errors="replace"))
3218
gnutls.global_set_log_function(debug_gnutls)
2487
logger.debug("GnuTLS: %s", string[:-1])
2489
(gnutls.library.functions
2490
.gnutls_global_set_log_function(debug_gnutls))
3220
2492
# Redirect stdin so all checkers get /dev/null
3221
2493
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3222
2494
os.dup2(null, sys.stdin.fileno())
3226
2498
# Need to fork before connecting to D-Bus
3227
2499
if not foreground:
3228
2500
# Close all input and output, do double fork, etc.
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.
2503
# multiprocessing will use threads, so before we use gobject we
2504
# need to inform gobject that threads will be used.
2505
gobject.threads_init()
3236
2507
global main_loop
3237
2508
# From the Avahi example code
3238
2509
DBusGMainLoop(set_as_default=True)
3239
main_loop = GLib.MainLoop()
2510
main_loop = gobject.MainLoop()
3240
2511
bus = dbus.SystemBus()
3241
2512
# End of Avahi example code
3244
2515
bus_name = dbus.service.BusName("se.recompile.Mandos",
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)
2516
bus, do_not_queue=True)
2517
old_bus_name = (dbus.service.BusName
2518
("se.bsnet.fukt.Mandos", bus,
2520
except dbus.exceptions.NameExistsException as e:
2521
logger.error("Disabling D-Bus:", exc_info=e)
3252
2522
use_dbus = False
3253
2523
server_settings["use_dbus"] = False
3254
2524
tcp_server.use_dbus = False
3256
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3257
service = AvahiServiceToSyslog(
3258
name=server_settings["servicename"],
3259
servicetype="_mandos._tcp",
3262
if server_settings["interface"]:
3263
service.interface = if_nametoindex(
3264
server_settings["interface"].encode("utf-8"))
2525
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2526
service = AvahiServiceToSyslog(name =
2527
server_settings["servicename"],
2528
servicetype = "_mandos._tcp",
2529
protocol = protocol, bus = bus)
2530
if server_settings["interface"]:
2531
service.interface = (if_nametoindex
2532
(str(server_settings["interface"])))
3266
2534
global multiprocessing_manager
3267
2535
multiprocessing_manager = multiprocessing.Manager()
3269
2537
client_class = Client
3271
client_class = functools.partial(ClientDBus, bus=bus)
2539
client_class = functools.partial(ClientDBus, bus = bus)
3273
2541
client_settings = Client.config_parser(client_config)
3274
2542
old_client_settings = {}
3275
2543
clients_data = {}
3277
2545
# This is used to redirect stdout and stderr for checker processes
3279
wnull = open(os.devnull, "w") # A writable /dev/null
2547
wnull = open(os.devnull, "w") # A writable /dev/null
3280
2548
# Only used if server is running in foreground but not in debug
3282
2550
if debug or not foreground:
3285
2553
# Get client data and settings from last running state.
3286
2554
if server_settings["restore"]:
3288
2556
with open(stored_state_path, "rb") as stored_state:
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]
2557
clients_data, old_client_settings = (pickle.load
3339
2559
os.remove(stored_state_path)
3340
2560
except IOError as e:
3341
2561
if e.errno == errno.ENOENT:
3342
log.warning("Could not load persistent state:"
3343
" %s", os.strerror(e.errno))
2562
logger.warning("Could not load persistent state: {0}"
2563
.format(os.strerror(e.errno)))
3345
log.critical("Could not load persistent state:",
2565
logger.critical("Could not load persistent state:",
3348
2568
except EOFError as e:
3349
log.warning("Could not load persistent state: EOFError:",
2569
logger.warning("Could not load persistent state: "
2570
"EOFError:", exc_info=e)
3352
2572
with PGPEngine() as pgp:
3353
for client_name, client in clients_data.items():
2573
for client_name, client in clients_data.iteritems():
3354
2574
# Skip removed clients
3355
2575
if client_name not in client_settings:
3358
2578
# Decide which value to use after restoring saved state.
3359
2579
# We have three different values: Old config file,
3360
2580
# new config file, and saved state.
3414
2638
for client_name in (set(client_settings)
3415
2639
- set(old_client_settings)):
3416
2640
clients_data[client_name] = client_settings[client_name]
3418
2642
# Create all client objects
3419
for client_name, client in clients_data.items():
2643
for client_name, client in clients_data.iteritems():
3420
2644
tcp_server.clients[client_name] = client_class(
3423
server_settings=server_settings)
2645
name = client_name, settings = client,
2646
server_settings = server_settings)
3425
2648
if not tcp_server.clients:
3426
log.warning("No clients defined")
2649
logger.warning("No clients defined")
3428
2651
if not foreground:
3429
2652
if pidfile is not None:
3433
print(pid, file=pidfile)
2656
pidfile.write(str(pid) + "\n".encode("utf-8"))
3434
2657
except IOError:
3435
log.error("Could not write to file %r with PID %d",
2658
logger.error("Could not write to file %r with PID %d",
3438
2661
del pidfilename
3440
for termsig in (signal.SIGHUP, signal.SIGTERM):
3441
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3442
lambda: main_loop.quit() and False)
2663
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2664
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3446
@alternate_dbus_interfaces(
3447
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3448
class MandosDBusService(DBusObjectWithObjectManager):
2667
@alternate_dbus_interfaces({"se.recompile.Mandos":
2668
"se.bsnet.fukt.Mandos"})
2669
class MandosDBusService(DBusObjectWithProperties):
3449
2670
"""A D-Bus proxy object"""
3451
2671
def __init__(self):
3452
2672
dbus.service.Object.__init__(self, bus, "/")
3454
2673
_interface = "se.recompile.Mandos"
2675
@dbus_interface_annotations(_interface)
2677
return { "org.freedesktop.DBus.Property"
2678
".EmitsChangedSignal":
3456
2681
@dbus.service.signal(_interface, signature="o")
3457
2682
def ClientAdded(self, objpath):
3461
2686
@dbus.service.signal(_interface, signature="ss")
3462
def ClientNotFound(self, key_id, address):
2687
def ClientNotFound(self, fingerprint, address):
3466
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3468
2691
@dbus.service.signal(_interface, signature="os")
3469
2692
def ClientRemoved(self, objpath, name):
3473
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3475
2696
@dbus.service.method(_interface, out_signature="ao")
3476
2697
def GetAllClients(self):
3478
return dbus.Array(c.dbus_object_path for c in
3479
tcp_server.clients.values())
3481
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2699
return dbus.Array(c.dbus_object_path
2701
tcp_server.clients.itervalues())
3483
2703
@dbus.service.method(_interface,
3484
2704
out_signature="a{oa{sv}}")
3485
2705
def GetAllClientsWithProperties(self):
3487
2707
return dbus.Dictionary(
3488
{c.dbus_object_path: c.GetAll(
3489
"se.recompile.Mandos.Client")
3490
for c in tcp_server.clients.values()},
2708
((c.dbus_object_path, c.GetAll(""))
2709
for c in tcp_server.clients.itervalues()),
3491
2710
signature="oa{sv}")
3493
2712
@dbus.service.method(_interface, in_signature="o")
3494
2713
def RemoveClient(self, object_path):
3496
for c in tcp_server.clients.values():
2715
for c in tcp_server.clients.itervalues():
3497
2716
if c.dbus_object_path == object_path:
3498
2717
del tcp_server.clients[c.name]
3499
2718
c.remove_from_connection()
3500
# Don't signal the disabling
2719
# Don't signal anything except ClientRemoved
3501
2720
c.disable(quiet=True)
3502
# Emit D-Bus signal for removal
3503
self.client_removed_signal(c)
2722
self.ClientRemoved(object_path, c.name)
3505
2724
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,
3545
2728
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
3553
2731
"Cleanup function; run on exit"
3557
mp.active_children()
2734
multiprocessing.active_children()
3559
2736
if not (tcp_server.clients or client_settings):
3562
2739
# Store client before exiting. Secrets are encrypted with key
3563
2740
# based on what config file has. If config file is
3564
2741
# removed/edited, old secret will thus be unrecovable.
3566
2743
with PGPEngine() as pgp:
3567
for client in tcp_server.clients.values():
2744
for client in tcp_server.clients.itervalues():
3568
2745
key = client_settings[client.name]["secret"]
3569
2746
client.encrypted_secret = pgp.encrypt(client.secret,
3571
2748
client_dict = {}
3573
2750
# A list of attributes that can not be pickled
3575
exclude = {"bus", "changedstate", "secret",
3576
"checker", "server_settings"}
3577
for name, typ in inspect.getmembers(dbus.service
2752
exclude = set(("bus", "changedstate", "secret",
2753
"checker", "server_settings"))
2754
for name, typ in (inspect.getmembers
2755
(dbus.service.Object)):
3579
2756
exclude.add(name)
3581
2758
client_dict["encrypted_secret"] = (client
3582
2759
.encrypted_secret)
3583
2760
for attr in client.client_structure:
3584
2761
if attr not in exclude:
3585
2762
client_dict[attr] = getattr(client, attr)
3587
2764
clients[client.name] = client_dict
3588
2765
del client_settings[client.name]["secret"]
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
2768
with (tempfile.NamedTemporaryFile
2769
(mode='wb', suffix=".pickle", prefix='clients-',
2770
dir=os.path.dirname(stored_state_path),
2771
delete=False)) as stored_state:
2772
pickle.dump((clients, client_settings), stored_state)
2773
tempname=stored_state.name
3600
2774
os.rename(tempname, stored_state_path)
3601
2775
except (IOError, OSError) as e:
3605
2779
except NameError:
3607
2781
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3608
log.warning("Could not save persistent state: %s",
3609
os.strerror(e.errno))
2782
logger.warning("Could not save persistent state: {0}"
2783
.format(os.strerror(e.errno)))
3611
log.warning("Could not save persistent state:",
2785
logger.warning("Could not save persistent state:",
3615
2789
# Delete all clients, and settings from config
3616
2790
while tcp_server.clients:
3617
2791
name, client = tcp_server.clients.popitem()
3619
2793
client.remove_from_connection()
3620
# Don't signal the disabling
2794
# Don't signal anything except ClientRemoved
3621
2795
client.disable(quiet=True)
3622
# Emit D-Bus signal for removal
3624
mandos_dbus_service.client_removed_signal(client)
2798
mandos_dbus_service.ClientRemoved(client
3625
2801
client_settings.clear()
3627
2803
atexit.register(cleanup)
3629
for client in tcp_server.clients.values():
2805
for client in tcp_server.clients.itervalues():
3631
# Emit D-Bus signal for adding
3632
mandos_dbus_service.client_added_signal(client)
2808
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3633
2809
# Need to initiate checking of clients
3634
2810
if client.enabled:
3635
client.init_checker(randomize_start=True)
2811
client.init_checker()
3637
2813
tcp_server.enable()
3638
2814
tcp_server.server_activate()
3640
2816
# Find out what port we got
3642
service.port = tcp_server.socket.getsockname()[1]
2817
service.port = tcp_server.socket.getsockname()[1]
3644
log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
" scope_id %d", *tcp_server.socket.getsockname())
2819
logger.info("Now listening on address %r, port %d,"
2820
" flowinfo %d, scope_id %d",
2821
*tcp_server.socket.getsockname())
3647
log.info("Now listening on address %r, port %d",
3648
*tcp_server.socket.getsockname())
3650
# service.interface = tcp_server.socket.getsockname()[3]
2823
logger.info("Now listening on address %r, port %d",
2824
*tcp_server.socket.getsockname())
2826
#service.interface = tcp_server.socket.getsockname()[3]
3654
# From the Avahi example code
3657
except dbus.exceptions.DBusException as error:
3658
log.critical("D-Bus Exception", exc_info=error)
3661
# End of Avahi example code
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")
2829
# From the Avahi example code
2832
except dbus.exceptions.DBusException as error:
2833
logger.critical("D-Bus Exception", exc_info=error)
2836
# End of Avahi example code
2838
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2839
lambda *args, **kwargs:
2840
(tcp_server.handle_request
2841
(*args[2:], **kwargs) or True))
2843
logger.debug("Starting main loop")
3670
2844
main_loop.run()
3671
2845
except AvahiError as error:
3672
log.critical("Avahi Error", exc_info=error)
2846
logger.critical("Avahi Error", exc_info=error)
3675
2849
except KeyboardInterrupt:
3677
2851
print("", file=sys.stderr)
3678
log.debug("Server received KeyboardInterrupt")
3679
log.debug("Server exiting")
2852
logger.debug("Server received KeyboardInterrupt")
2853
logger.debug("Server exiting")
3680
2854
# Must run before the D-Bus bus name gets deregistered
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))
2857
if __name__ == '__main__':