70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
82
70
import dbus.service
83
from gi.repository import GLib
84
73
from dbus.mainloop.glib import DBusGMainLoop
87
76
import xml.dom.minidom
90
# Try to find the value of SO_BINDTODEVICE:
92
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
93
# newer, and it is also the most natural place for it:
94
81
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
95
82
except AttributeError:
97
# This is where SO_BINDTODEVICE was up to and including Python
99
84
from IN import SO_BINDTODEVICE
100
85
except ImportError:
101
# In Python 2.7 it seems to have been removed entirely.
102
# Try running the C preprocessor:
104
cc = subprocess.Popen(["cc", "--language=c", "-E",
106
stdin=subprocess.PIPE,
107
stdout=subprocess.PIPE)
108
stdout = cc.communicate(
109
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
110
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
111
except (OSError, ValueError, IndexError):
113
SO_BINDTODEVICE = None
115
if sys.version_info.major == 2:
86
SO_BINDTODEVICE = None
119
90
stored_state_file = "clients.pickle"
121
92
logger = logging.getLogger()
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
125
if_nametoindex = ctypes.cdll.LoadLibrary(
126
ctypes.util.find_library("c")).if_nametoindex
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
127
101
except (OSError, AttributeError):
129
102
def if_nametoindex(interface):
130
103
"Get an interface index the hard way, i.e. using fcntl()"
131
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
132
105
with contextlib.closing(socket.socket()) as s:
133
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
134
struct.pack(b"16s16x", interface))
135
interface_index = struct.unpack("I", ifreq[16:20])[0]
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
136
111
return interface_index
139
def copy_function(func):
140
"""Make a copy of a function"""
141
if sys.version_info.major == 2:
142
return types.FunctionType(func.func_code,
148
return types.FunctionType(func.__code__,
155
def initlogger(debug, level=logging.WARNING):
114
def initlogger(level=logging.WARNING):
156
115
"""init logger and add loglevel"""
159
syslogger = (logging.handlers.SysLogHandler(
160
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
162
117
syslogger.setFormatter(logging.Formatter
163
118
('Mandos [%(process)d]: %(levelname)s:'
165
120
logger.addHandler(syslogger)
168
console = logging.StreamHandler()
169
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
173
logger.addHandler(console)
122
console = logging.StreamHandler()
123
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
127
logger.addHandler(console)
174
128
logger.setLevel(level)
177
class PGPError(Exception):
178
"""Exception if encryption/decryption fails"""
131
class CryptoError(Exception):
182
class PGPEngine(object):
135
class Crypto(object):
183
136
"""A simple class for OpenPGP symmetric encryption & decryption"""
185
137
def __init__(self):
138
self.gnupg = GnuPGInterface.GnuPG()
186
139
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
189
output = subprocess.check_output(["gpgconf"])
190
for line in output.splitlines():
191
name, text, path = line.split(b":")
196
if e.errno != errno.ENOENT:
198
self.gnupgargs = ['--batch',
199
'--homedir', self.tempdir,
202
# Only GPG version 1 has the --no-use-agent option.
203
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
204
self.gnupgargs.append("--no-use-agent")
140
self.gnupg = GnuPGInterface.GnuPG()
141
self.gnupg.options.meta_interactive = False
142
self.gnupg.options.homedir = self.tempdir
143
self.gnupg.options.extra_args.extend(['--force-mdc',
206
146
def __enter__(self):
209
def __exit__(self, exc_type, exc_value, traceback):
149
def __exit__ (self, exc_type, exc_value, traceback):
213
153
def __del__(self):
216
156
def _cleanup(self):
217
157
if self.tempdir is not None:
218
158
# Delete contents of tempdir
219
159
for root, dirs, files in os.walk(self.tempdir,
221
161
for filename in files:
222
162
os.remove(os.path.join(root, filename))
223
163
for dirname in dirs:
226
166
os.rmdir(self.tempdir)
227
167
self.tempdir = None
229
169
def password_encode(self, password):
230
170
# Passphrase can not be empty and can not contain newlines or
231
171
# NUL bytes. So we prefix it and hex encode it.
232
encoded = b"mandos" + binascii.hexlify(password)
233
if len(encoded) > 2048:
234
# GnuPG can't handle long passwords, so encode differently
235
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
236
.replace(b"\n", b"\\n")
237
.replace(b"\0", b"\\x00"))
172
return b"mandos" + binascii.hexlify(password)
240
174
def encrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
254
if proc.returncode != 0:
175
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
178
proc = self.gnupg.run(['--symmetric'],
179
create_fhs=['stdin', 'stdout'],
180
attach_fhs={'stderr': devnull})
181
with contextlib.closing(proc.handles['stdin']) as f:
183
with contextlib.closing(proc.handles['stdout']) as f:
184
ciphertext = f.read()
188
self.gnupg.passphrase = None
256
189
return ciphertext
258
191
def decrypt(self, data, password):
259
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
262
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
272
if proc.returncode != 0:
192
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
195
proc = self.gnupg.run(['--decrypt'],
196
create_fhs=['stdin', 'stdout'],
197
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
200
with contextlib.closing(proc.handles['stdout']) as f:
201
decrypted_plaintext = f.read()
205
self.gnupg.passphrase = None
274
206
return decrypted_plaintext
277
# Pretend that we have an Avahi module
279
"""This isn't so much a class as it is a module-like namespace."""
280
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
290
def string_array_to_txt_array(t):
291
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
for s in t), signature="ay")
293
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
294
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
295
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
296
SERVER_INVALID = 0 # avahi-common/defs.h
297
SERVER_REGISTERING = 1 # avahi-common/defs.h
298
SERVER_RUNNING = 2 # avahi-common/defs.h
299
SERVER_COLLISION = 3 # avahi-common/defs.h
300
SERVER_FAILURE = 4 # avahi-common/defs.h
303
210
class AvahiError(Exception):
304
211
def __init__(self, value, *args, **kwargs):
305
212
self.value = value
306
return super(AvahiError, self).__init__(value, *args,
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
310
217
class AvahiServiceError(AvahiError):
314
220
class AvahiGroupError(AvahiError):
318
224
class AvahiService(object):
319
225
"""An Avahi (Zeroconf) service.
322
228
interface: integer; avahi.IF_UNSPEC or an interface index.
323
229
Used to optionally bind to the specified interface.
324
230
name: string; Example: 'Mandos'
325
231
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
232
See <http://www.dns-sd.org/ServiceTypes.html>
327
233
port: integer; what port to announce
328
234
TXT: list of strings; TXT record for the service
329
235
domain: string; Domain to publish on, default to .local if empty.
488
364
follow_name_owner_changes=True),
489
365
avahi.DBUS_INTERFACE_SERVER)
490
366
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
367
self.server_state_changed)
492
368
self.server_state_changed(self.server.GetState())
495
370
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
372
"""Add the new name to the syslog messages"""
498
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
505
# Pretend that we have a GnuTLS module
506
class gnutls(object):
507
"""This isn't so much a class as it is a module-like namespace."""
509
library = ctypes.util.find_library("gnutls")
511
library = ctypes.util.find_library("gnutls-deb0")
512
_library = ctypes.cdll.LoadLibrary(library)
515
# Unless otherwise indicated, the constants and types below are
516
# all from the gnutls/gnutls.h C header file.
527
E_NO_CERTIFICATE_FOUND = -49
532
KEYID_USE_SHA256 = 1 # gnutls/x509.h
533
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
536
class session_int(ctypes.Structure):
538
session_t = ctypes.POINTER(session_int)
540
class certificate_credentials_st(ctypes.Structure):
542
certificate_credentials_t = ctypes.POINTER(
543
certificate_credentials_st)
544
certificate_type_t = ctypes.c_int
546
class datum_t(ctypes.Structure):
547
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
548
('size', ctypes.c_uint)]
550
class openpgp_crt_int(ctypes.Structure):
552
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
553
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
554
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
555
credentials_type_t = ctypes.c_int
556
transport_ptr_t = ctypes.c_void_p
557
close_request_t = ctypes.c_int
560
class Error(Exception):
561
def __init__(self, message=None, code=None, args=()):
562
# Default usage is by a message string, but if a return
563
# code is passed, convert it to a string with
566
if message is None and code is not None:
567
message = gnutls.strerror(code)
568
return super(gnutls.Error, self).__init__(
571
class CertificateSecurityError(Error):
575
class Credentials(object):
577
self._c_object = gnutls.certificate_credentials_t()
578
gnutls.certificate_allocate_credentials(
579
ctypes.byref(self._c_object))
580
self.type = gnutls.CRD_CERTIFICATE
583
gnutls.certificate_free_credentials(self._c_object)
585
class ClientSession(object):
586
def __init__(self, socket, credentials=None):
587
self._c_object = gnutls.session_t()
588
gnutls_flags = gnutls.CLIENT
589
if gnutls.check_version("3.5.6"):
590
gnutls_flags |= gnutls.NO_TICKETS
592
gnutls_flags |= gnutls.ENABLE_RAWPK
593
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
595
gnutls.set_default_priority(self._c_object)
596
gnutls.transport_set_ptr(self._c_object, socket.fileno())
597
gnutls.handshake_set_private_extensions(self._c_object,
600
if credentials is None:
601
credentials = gnutls.Credentials()
602
gnutls.credentials_set(self._c_object, credentials.type,
603
ctypes.cast(credentials._c_object,
605
self.credentials = credentials
608
gnutls.deinit(self._c_object)
611
return gnutls.handshake(self._c_object)
613
def send(self, data):
617
data_len -= gnutls.record_send(self._c_object,
622
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
624
# Error handling functions
625
def _error_code(result):
626
"""A function to raise exceptions on errors, suitable
627
for the 'restype' attribute on ctypes functions"""
630
if result == gnutls.E_NO_CERTIFICATE_FOUND:
631
raise gnutls.CertificateSecurityError(code=result)
632
raise gnutls.Error(code=result)
634
def _retry_on_error(result, func, arguments):
635
"""A function to retry on some errors, suitable
636
for the 'errcheck' attribute on ctypes functions"""
638
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
639
return _error_code(result)
640
result = func(*arguments)
643
# Unless otherwise indicated, the function declarations below are
644
# all from the gnutls/gnutls.h C header file.
647
priority_set_direct = _library.gnutls_priority_set_direct
648
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
649
ctypes.POINTER(ctypes.c_char_p)]
650
priority_set_direct.restype = _error_code
652
init = _library.gnutls_init
653
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
654
init.restype = _error_code
656
set_default_priority = _library.gnutls_set_default_priority
657
set_default_priority.argtypes = [session_t]
658
set_default_priority.restype = _error_code
660
record_send = _library.gnutls_record_send
661
record_send.argtypes = [session_t, ctypes.c_void_p,
663
record_send.restype = ctypes.c_ssize_t
664
record_send.errcheck = _retry_on_error
666
certificate_allocate_credentials = (
667
_library.gnutls_certificate_allocate_credentials)
668
certificate_allocate_credentials.argtypes = [
669
ctypes.POINTER(certificate_credentials_t)]
670
certificate_allocate_credentials.restype = _error_code
672
certificate_free_credentials = (
673
_library.gnutls_certificate_free_credentials)
674
certificate_free_credentials.argtypes = [
675
certificate_credentials_t]
676
certificate_free_credentials.restype = None
678
handshake_set_private_extensions = (
679
_library.gnutls_handshake_set_private_extensions)
680
handshake_set_private_extensions.argtypes = [session_t,
682
handshake_set_private_extensions.restype = None
684
credentials_set = _library.gnutls_credentials_set
685
credentials_set.argtypes = [session_t, credentials_type_t,
687
credentials_set.restype = _error_code
689
strerror = _library.gnutls_strerror
690
strerror.argtypes = [ctypes.c_int]
691
strerror.restype = ctypes.c_char_p
693
certificate_type_get = _library.gnutls_certificate_type_get
694
certificate_type_get.argtypes = [session_t]
695
certificate_type_get.restype = _error_code
697
certificate_get_peers = _library.gnutls_certificate_get_peers
698
certificate_get_peers.argtypes = [session_t,
699
ctypes.POINTER(ctypes.c_uint)]
700
certificate_get_peers.restype = ctypes.POINTER(datum_t)
702
global_set_log_level = _library.gnutls_global_set_log_level
703
global_set_log_level.argtypes = [ctypes.c_int]
704
global_set_log_level.restype = None
706
global_set_log_function = _library.gnutls_global_set_log_function
707
global_set_log_function.argtypes = [log_func]
708
global_set_log_function.restype = None
710
deinit = _library.gnutls_deinit
711
deinit.argtypes = [session_t]
712
deinit.restype = None
714
handshake = _library.gnutls_handshake
715
handshake.argtypes = [session_t]
716
handshake.restype = _error_code
717
handshake.errcheck = _retry_on_error
719
transport_set_ptr = _library.gnutls_transport_set_ptr
720
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
721
transport_set_ptr.restype = None
723
bye = _library.gnutls_bye
724
bye.argtypes = [session_t, close_request_t]
725
bye.restype = _error_code
726
bye.errcheck = _retry_on_error
728
check_version = _library.gnutls_check_version
729
check_version.argtypes = [ctypes.c_char_p]
730
check_version.restype = ctypes.c_char_p
732
_need_version = b"3.3.0"
733
if check_version(_need_version) is None:
734
raise self.Error("Needs GnuTLS {} or later"
735
.format(_need_version))
737
_tls_rawpk_version = b"3.6.6"
738
has_rawpk = bool(check_version(_tls_rawpk_version))
742
class pubkey_st(ctypes.Structure):
744
pubkey_t = ctypes.POINTER(pubkey_st)
746
x509_crt_fmt_t = ctypes.c_int
748
# All the function declarations below are from gnutls/abstract.h
749
pubkey_init = _library.gnutls_pubkey_init
750
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
751
pubkey_init.restype = _error_code
753
pubkey_import = _library.gnutls_pubkey_import
754
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
756
pubkey_import.restype = _error_code
758
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
759
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
760
ctypes.POINTER(ctypes.c_ubyte),
761
ctypes.POINTER(ctypes.c_size_t)]
762
pubkey_get_key_id.restype = _error_code
764
pubkey_deinit = _library.gnutls_pubkey_deinit
765
pubkey_deinit.argtypes = [pubkey_t]
766
pubkey_deinit.restype = None
768
# All the function declarations below are from gnutls/openpgp.h
770
openpgp_crt_init = _library.gnutls_openpgp_crt_init
771
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
772
openpgp_crt_init.restype = _error_code
774
openpgp_crt_import = _library.gnutls_openpgp_crt_import
775
openpgp_crt_import.argtypes = [openpgp_crt_t,
776
ctypes.POINTER(datum_t),
778
openpgp_crt_import.restype = _error_code
780
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
781
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
782
ctypes.POINTER(ctypes.c_uint)]
783
openpgp_crt_verify_self.restype = _error_code
785
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
786
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
787
openpgp_crt_deinit.restype = None
789
openpgp_crt_get_fingerprint = (
790
_library.gnutls_openpgp_crt_get_fingerprint)
791
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
795
openpgp_crt_get_fingerprint.restype = _error_code
797
if check_version("3.6.4"):
798
certificate_type_get2 = _library.gnutls_certificate_type_get2
799
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
800
certificate_type_get2.restype = _error_code
802
# Remove non-public functions
803
del _error_code, _retry_on_error
806
def call_pipe(connection, # : multiprocessing.Connection
807
func, *args, **kwargs):
808
"""This function is meant to be called by multiprocessing.Process
810
This function runs func(*args, **kwargs), and writes the resulting
811
return value on the provided multiprocessing.Connection.
813
connection.send(func(*args, **kwargs))
380
def timedelta_to_milliseconds(td):
381
"Convert a datetime.timedelta() to milliseconds"
382
return ((td.days * 24 * 60 * 60 * 1000)
383
+ (td.seconds * 1000)
384
+ (td.microseconds // 1000))
817
386
class Client(object):
818
387
"""A representation of a client host served by this server.
821
390
approved: bool(); 'None' if not yet approved/disapproved
822
391
approval_delay: datetime.timedelta(); Time to wait for approval
824
393
checker: subprocess.Popen(); a running checker process used
825
394
to see if the client lives.
826
395
'None' if no process is running.
827
checker_callback_tag: a GLib event source tag, or None
396
checker_callback_tag: a gobject event source tag, or None
828
397
checker_command: string; External command which is run to check
829
398
if client lives. %() expansions are done at
830
399
runtime with vars(self) as dict, so that for
831
400
instance %(name)s can be used in the command.
832
checker_initiator_tag: a GLib event source tag, or None
401
checker_initiator_tag: a gobject event source tag, or None
833
402
created: datetime.datetime(); (UTC) object creation
834
403
client_structure: Object describing what attributes a client has
835
404
and is used for storing the client at exit
836
405
current_checker_command: string; current running checker_command
837
disable_initiator_tag: a GLib event source tag, or None
406
disable_initiator_tag: a gobject event source tag, or None
839
408
fingerprint: string (40 or 32 hexadecimal digits); used to
840
uniquely identify an OpenPGP client
841
key_id: string (64 hexadecimal digits); used to uniquely identify
842
a client using raw public keys
409
uniquely identify the client
843
410
host: string; available for use by the checker command
844
411
interval: datetime.timedelta(); How often to start a new checker
845
412
last_approval_request: datetime.datetime(); (UTC) or None
846
413
last_checked_ok: datetime.datetime(); (UTC) or None
847
415
last_checker_status: integer between 0 and 255 reflecting exit
848
416
status of last checker. -1 reflects crashed
849
checker, -2 means no checker completed yet.
850
last_checker_signal: The signal which killed the last checker, if
851
last_checker_status is -1
852
418
last_enabled: datetime.datetime(); (UTC) or None
853
419
name: string; from the config file, used in log messages and
854
420
D-Bus identifiers
855
421
secret: bytestring; sent verbatim (over TLS) to client
856
422
timeout: datetime.timedelta(); How long from last_checked_ok
857
423
until this client is disabled
858
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
859
425
runtime_expansions: Allowed attributes for runtime expansion.
860
426
expires: datetime.datetime(); time (UTC) when a client will be
861
427
disabled, or None
862
server_settings: The server_settings dict from main()
865
430
runtime_expansions = ("approval_delay", "approval_duration",
866
"created", "enabled", "expires", "key_id",
867
"fingerprint", "host", "interval",
868
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
869
433
"last_enabled", "name", "timeout")
872
"extended_timeout": "PT15M",
874
"checker": "fping -q -- %%(host)s",
876
"approval_delay": "PT0S",
877
"approval_duration": "PT1S",
878
"approved_by_default": "True",
883
def config_parser(config):
884
"""Construct a new dict of client settings of this form:
885
{ client_name: {setting_name: value, ...}, ...}
886
with exceptions for any special settings as defined above.
887
NOTE: Must be a pure function. Must return the same result
888
value given the same arguments.
891
for client_name in config.sections():
892
section = dict(config.items(client_name))
893
client = settings[client_name] = {}
895
client["host"] = section["host"]
896
# Reformat values from string types to Python types
897
client["approved_by_default"] = config.getboolean(
898
client_name, "approved_by_default")
899
client["enabled"] = config.getboolean(client_name,
902
# Uppercase and remove spaces from key_id and fingerprint
903
# for later comparison purposes with return value from the
904
# key_id() and fingerprint() functions
905
client["key_id"] = (section.get("key_id", "").upper()
907
client["fingerprint"] = (section["fingerprint"].upper()
909
if "secret" in section:
910
client["secret"] = codecs.decode(section["secret"]
913
elif "secfile" in section:
914
with open(os.path.expanduser(os.path.expandvars
915
(section["secfile"])),
917
client["secret"] = secfile.read()
919
raise TypeError("No secret or secfile for section {}"
921
client["timeout"] = string_to_delta(section["timeout"])
922
client["extended_timeout"] = string_to_delta(
923
section["extended_timeout"])
924
client["interval"] = string_to_delta(section["interval"])
925
client["approval_delay"] = string_to_delta(
926
section["approval_delay"])
927
client["approval_duration"] = string_to_delta(
928
section["approval_duration"])
929
client["checker_command"] = section["checker"]
930
client["last_approval_request"] = None
931
client["last_checked_ok"] = None
932
client["last_checker_status"] = -2
936
def __init__(self, settings, name=None, server_settings=None):
435
def timeout_milliseconds(self):
436
"Return the 'timeout' attribute in milliseconds"
437
return timedelta_to_milliseconds(self.timeout)
439
def extended_timeout_milliseconds(self):
440
"Return the 'extended_timeout' attribute in milliseconds"
441
return timedelta_to_milliseconds(self.extended_timeout)
443
def interval_milliseconds(self):
444
"Return the 'interval' attribute in milliseconds"
445
return timedelta_to_milliseconds(self.interval)
447
def approval_delay_milliseconds(self):
448
return timedelta_to_milliseconds(self.approval_delay)
450
def __init__(self, name = None, config=None):
451
"""Note: the 'checker' key in 'config' sets the
452
'checker_command' attribute and *not* the 'checker'
938
if server_settings is None:
940
self.server_settings = server_settings
941
# adding all client settings
942
for setting, value in settings.items():
943
setattr(self, setting, value)
946
if not hasattr(self, "last_enabled"):
947
self.last_enabled = datetime.datetime.utcnow()
948
if not hasattr(self, "expires"):
949
self.expires = (datetime.datetime.utcnow()
952
self.last_enabled = None
955
457
logger.debug("Creating client %r", self.name)
956
logger.debug(" Key ID: %s", self.key_id)
458
# Uppercase and remove spaces from fingerprint for later
459
# comparison purposes with return value from the fingerprint()
461
self.fingerprint = (config["fingerprint"].upper()
957
463
logger.debug(" Fingerprint: %s", self.fingerprint)
958
self.created = settings.get("created",
959
datetime.datetime.utcnow())
961
# attributes specific for this server instance
464
if "secret" in config:
465
self.secret = config["secret"].decode("base64")
466
elif "secfile" in config:
467
with open(os.path.expanduser(os.path.expandvars
468
(config["secfile"])),
470
self.secret = secfile.read()
472
raise TypeError("No secret or secfile for client %s"
474
self.host = config.get("host", "")
475
self.created = datetime.datetime.utcnow()
476
self.enabled = config.get("enabled", True)
477
self.last_approval_request = None
479
self.last_enabled = datetime.datetime.utcnow()
481
self.last_enabled = None
482
self.last_checked_ok = None
483
self.last_checker_status = None
484
self.timeout = string_to_delta(config["timeout"])
485
self.extended_timeout = string_to_delta(config
486
["extended_timeout"])
487
self.interval = string_to_delta(config["interval"])
962
488
self.checker = None
963
489
self.checker_initiator_tag = None
964
490
self.disable_initiator_tag = None
492
self.expires = datetime.datetime.utcnow() + self.timeout
965
495
self.checker_callback_tag = None
496
self.checker_command = config["checker"]
966
497
self.current_checker_command = None
967
498
self.approved = None
499
self.approved_by_default = config.get("approved_by_default",
968
501
self.approvals_pending = 0
969
self.changedstate = multiprocessing_manager.Condition(
970
multiprocessing_manager.Lock())
971
self.client_structure = [attr
972
for attr in self.__dict__.keys()
502
self.approval_delay = string_to_delta(
503
config["approval_delay"])
504
self.approval_duration = string_to_delta(
505
config["approval_duration"])
506
self.changedstate = (multiprocessing_manager
507
.Condition(multiprocessing_manager
509
self.client_structure = [attr for attr in
510
self.__dict__.iterkeys()
973
511
if not attr.startswith("_")]
974
512
self.client_structure.append("client_structure")
976
for name, t in inspect.getmembers(
977
type(self), lambda obj: isinstance(obj, property)):
514
for name, t in inspect.getmembers(type(self),
978
518
if not name.startswith("_"):
979
519
self.client_structure.append(name)
981
521
# Send notice to process children that client state has changed
982
522
def send_changedstate(self):
983
523
with self.changedstate:
984
524
self.changedstate.notify_all()
986
526
def enable(self):
987
527
"""Start this client's checker and timeout hooks"""
988
528
if getattr(self, "enabled", False):
989
529
# Already enabled
531
self.send_changedstate()
991
532
self.expires = datetime.datetime.utcnow() + self.timeout
992
533
self.enabled = True
993
534
self.last_enabled = datetime.datetime.utcnow()
994
535
self.init_checker()
995
self.send_changedstate()
997
537
def disable(self, quiet=True):
998
538
"""Disable this client."""
999
539
if not getattr(self, "enabled", False):
542
self.send_changedstate()
1002
544
logger.info("Disabling client %s", self.name)
1003
if getattr(self, "disable_initiator_tag", None) is not None:
1004
GLib.source_remove(self.disable_initiator_tag)
545
if getattr(self, "disable_initiator_tag", False):
546
gobject.source_remove(self.disable_initiator_tag)
1005
547
self.disable_initiator_tag = None
1006
548
self.expires = None
1007
if getattr(self, "checker_initiator_tag", None) is not None:
1008
GLib.source_remove(self.checker_initiator_tag)
549
if getattr(self, "checker_initiator_tag", False):
550
gobject.source_remove(self.checker_initiator_tag)
1009
551
self.checker_initiator_tag = None
1010
552
self.stop_checker()
1011
553
self.enabled = False
1013
self.send_changedstate()
1014
# Do not run this again if called by a GLib.timeout_add
554
# Do not run this again if called by a gobject.timeout_add
1017
557
def __del__(self):
1020
560
def init_checker(self):
1021
561
# Schedule a new checker to be started an 'interval' from now,
1022
562
# and every interval from then on.
1023
if self.checker_initiator_tag is not None:
1024
GLib.source_remove(self.checker_initiator_tag)
1025
self.checker_initiator_tag = GLib.timeout_add(
1026
int(self.interval.total_seconds() * 1000),
563
self.checker_initiator_tag = (gobject.timeout_add
564
(self.interval_milliseconds(),
1028
566
# Schedule a disable() when 'timeout' has passed
1029
if self.disable_initiator_tag is not None:
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = GLib.timeout_add(
1032
int(self.timeout.total_seconds() * 1000), self.disable)
567
self.disable_initiator_tag = (gobject.timeout_add
568
(self.timeout_milliseconds(),
1033
570
# Also start a new checker *right now*.
1034
571
self.start_checker()
1036
def checker_callback(self, source, condition, connection,
573
def checker_callback(self, pid, condition, command):
1038
574
"""The checker has completed, so take appropriate actions."""
1039
575
self.checker_callback_tag = None
1040
576
self.checker = None
1041
# Read return code from connection (see call_pipe)
1042
returncode = connection.recv()
1046
self.last_checker_status = returncode
1047
self.last_checker_signal = None
577
if os.WIFEXITED(condition):
578
self.last_checker_status = os.WEXITSTATUS(condition)
1048
579
if self.last_checker_status == 0:
1049
580
logger.info("Checker for %(name)s succeeded",
1051
582
self.checked_ok()
1053
logger.info("Checker for %(name)s failed", vars(self))
584
logger.info("Checker for %(name)s failed",
1055
587
self.last_checker_status = -1
1056
self.last_checker_signal = -returncode
1057
588
logger.warning("Checker for %(name)s crashed?",
1061
def checked_ok(self):
1062
"""Assert that the client has been seen, alive and well."""
1063
self.last_checked_ok = datetime.datetime.utcnow()
1064
self.last_checker_status = 0
1065
self.last_checker_signal = None
1068
def bump_timeout(self, timeout=None):
1069
"""Bump up the timeout for this client."""
591
def checked_ok(self, timeout=None):
592
"""Bump up the timeout for this client.
594
This should only be called when the client has been seen,
1070
597
if timeout is None:
1071
598
timeout = self.timeout
599
self.last_checked_ok = datetime.datetime.utcnow()
1072
600
if self.disable_initiator_tag is not None:
1073
GLib.source_remove(self.disable_initiator_tag)
1074
self.disable_initiator_tag = None
601
gobject.source_remove(self.disable_initiator_tag)
1075
602
if getattr(self, "enabled", False):
1076
self.disable_initiator_tag = GLib.timeout_add(
1077
int(timeout.total_seconds() * 1000), self.disable)
603
self.disable_initiator_tag = (gobject.timeout_add
604
(timedelta_to_milliseconds
605
(timeout), self.disable))
1078
606
self.expires = datetime.datetime.utcnow() + timeout
1080
608
def need_approval(self):
1081
609
self.last_approval_request = datetime.datetime.utcnow()
1083
611
def start_checker(self):
1084
612
"""Start a new checker subprocess if one is not running.
1086
614
If a checker already exists, leave it running and do
1088
616
# The reason for not killing a running checker is that if we
1089
# did that, and if a checker (for some reason) started running
1090
# slowly and taking more than 'interval' time, then the client
1091
# would inevitably timeout, since no checker would get a
1092
# chance to run to completion. If we instead leave running
617
# did that, then if a checker (for some reason) started
618
# running slowly and taking more than 'interval' time, the
619
# client would inevitably timeout, since no checker would get
620
# a chance to run to completion. If we instead leave running
1093
621
# checkers alone, the checker would have to take more time
1094
622
# than 'timeout' for the client to be disabled, which is as it
1097
if self.checker is not None and not self.checker.is_alive():
1098
logger.warning("Checker was not alive; joining")
625
# If a checker exists, make sure it is not a zombie
627
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
628
except (AttributeError, OSError) as error:
629
if (isinstance(error, OSError)
630
and error.errno != errno.ECHILD):
634
logger.warning("Checker was a zombie")
635
gobject.source_remove(self.checker_callback_tag)
636
self.checker_callback(pid, status,
637
self.current_checker_command)
1101
638
# Start a new checker if needed
1102
639
if self.checker is None:
1103
# Escape attributes for the shell
1105
attr: re.escape(str(getattr(self, attr)))
1106
for attr in self.runtime_expansions}
1108
command = self.checker_command % escaped_attrs
1109
except TypeError as error:
1110
logger.error('Could not format string "%s"',
1111
self.checker_command,
1113
return True # Try again later
641
# In case checker_command has exactly one % operator
642
command = self.checker_command % self.host
644
# Escape attributes for the shell
645
escaped_attrs = dict(
647
re.escape(unicode(str(getattr(self, attr, "")),
651
self.runtime_expansions)
654
command = self.checker_command % escaped_attrs
655
except TypeError as error:
656
logger.error('Could not format string "%s":'
657
' %s', self.checker_command, error)
658
return True # Try again later
1114
659
self.current_checker_command = command
1115
logger.info("Starting checker %r for %s", command,
1117
# We don't need to redirect stdout and stderr, since
1118
# in normal mode, that is already done by daemon(),
1119
# and in debug mode we don't want to. (Stdin is
1120
# always replaced by /dev/null.)
1121
# The exception is when not debugging but nevertheless
1122
# running in the foreground; use the previously
1124
popen_args = {"close_fds": True,
1127
if (not self.server_settings["debug"]
1128
and self.server_settings["foreground"]):
1129
popen_args.update({"stdout": wnull,
1131
pipe = multiprocessing.Pipe(duplex=False)
1132
self.checker = multiprocessing.Process(
1134
args=(pipe[1], subprocess.call, command),
1136
self.checker.start()
1137
self.checker_callback_tag = GLib.io_add_watch(
1138
pipe[0].fileno(), GLib.IO_IN,
1139
self.checker_callback, pipe[0], command)
1140
# Re-run this periodically if run by GLib.timeout_add
661
logger.info("Starting checker %r for %s",
663
# We don't need to redirect stdout and stderr, since
664
# in normal mode, that is already done by daemon(),
665
# and in debug mode we don't want to. (Stdin is
666
# always replaced by /dev/null.)
667
self.checker = subprocess.Popen(command,
670
self.checker_callback_tag = (gobject.child_watch_add
672
self.checker_callback,
674
# The checker may have completed before the gobject
675
# watch was added. Check for this.
676
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
gobject.source_remove(self.checker_callback_tag)
679
self.checker_callback(pid, status, command)
680
except OSError as error:
681
logger.error("Failed to start subprocess: %s",
683
# Re-run this periodically if run by gobject.timeout_add
1143
686
def stop_checker(self):
1144
687
"""Force the checker process, if any, to stop."""
1145
688
if self.checker_callback_tag:
1146
GLib.source_remove(self.checker_callback_tag)
689
gobject.source_remove(self.checker_callback_tag)
1147
690
self.checker_callback_tag = None
1148
691
if getattr(self, "checker", None) is None:
1150
693
logger.debug("Stopping checker for %(name)s", vars(self))
1151
self.checker.terminate()
695
os.kill(self.checker.pid, signal.SIGTERM)
697
#if self.checker.poll() is None:
698
# os.kill(self.checker.pid, signal.SIGKILL)
699
except OSError as error:
700
if error.errno != errno.ESRCH: # No such process
1152
702
self.checker = None
1155
def dbus_service_property(dbus_interface,
705
def dbus_service_property(dbus_interface, signature="v",
706
access="readwrite", byte_arrays=False):
1159
707
"""Decorators for marking methods of a DBusObjectWithProperties to
1160
708
become properties on the D-Bus.
1162
710
The decorated method will be called with no arguments by "Get"
1163
711
and with one argument by "Set".
1165
713
The parameters, where they are supported, are the same as
1166
714
dbus.service.method, except there is only "signature", since the
1167
715
type from Get() and the type sent to Set() is the same.
1250
class DBusObjectWithAnnotations(dbus.service.Object):
1251
"""A D-Bus object with annotations.
1253
Classes inheriting from this can use the dbus_annotations
1254
decorator to add annotations to methods or signals.
1258
def _is_dbus_thing(thing):
1259
"""Returns a function testing if an attribute is a D-Bus thing
1261
If called like _is_dbus_thing("method") it returns a function
1262
suitable for use as predicate to inspect.getmembers().
1264
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1267
def _get_all_dbus_things(self, thing):
1268
"""Returns a generator of (name, attribute) pairs
1270
return ((getattr(athing.__get__(self), "_dbus_name", name),
1271
athing.__get__(self))
1272
for cls in self.__class__.__mro__
1274
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1276
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1278
path_keyword='object_path',
1279
connection_keyword='connection')
1280
def Introspect(self, object_path, connection):
1281
"""Overloading of standard D-Bus method.
1283
Inserts annotation tags on methods and signals.
1285
xmlstring = dbus.service.Object.Introspect(self, object_path,
1288
document = xml.dom.minidom.parseString(xmlstring)
1290
for if_tag in document.getElementsByTagName("interface"):
1291
# Add annotation tags
1292
for typ in ("method", "signal"):
1293
for tag in if_tag.getElementsByTagName(typ):
1295
for name, prop in (self.
1296
_get_all_dbus_things(typ)):
1297
if (name == tag.getAttribute("name")
1298
and prop._dbus_interface
1299
== if_tag.getAttribute("name")):
1300
annots.update(getattr(
1301
prop, "_dbus_annotations", {}))
1302
for name, value in annots.items():
1303
ann_tag = document.createElement(
1305
ann_tag.setAttribute("name", name)
1306
ann_tag.setAttribute("value", value)
1307
tag.appendChild(ann_tag)
1308
# Add interface annotation tags
1309
for annotation, value in dict(
1310
itertools.chain.from_iterable(
1311
annotations().items()
1312
for name, annotations
1313
in self._get_all_dbus_things("interface")
1314
if name == if_tag.getAttribute("name")
1316
ann_tag = document.createElement("annotation")
1317
ann_tag.setAttribute("name", annotation)
1318
ann_tag.setAttribute("value", value)
1319
if_tag.appendChild(ann_tag)
1320
# Fix argument name for the Introspect method itself
1321
if (if_tag.getAttribute("name")
1322
== dbus.INTROSPECTABLE_IFACE):
1323
for cn in if_tag.getElementsByTagName("method"):
1324
if cn.getAttribute("name") == "Introspect":
1325
for arg in cn.getElementsByTagName("arg"):
1326
if (arg.getAttribute("direction")
1328
arg.setAttribute("name",
1330
xmlstring = document.toxml("utf-8")
1332
except (AttributeError, xml.dom.DOMException,
1333
xml.parsers.expat.ExpatError) as error:
1334
logger.error("Failed to override Introspection method",
1339
class DBusObjectWithProperties(DBusObjectWithAnnotations):
754
class DBusObjectWithProperties(dbus.service.Object):
1340
755
"""A D-Bus object with properties.
1342
757
Classes inheriting from this can use the dbus_service_property
1343
758
decorator to expose methods as D-Bus properties. It exposes the
1344
759
standard Get(), Set(), and GetAll() methods on the D-Bus.
763
def _is_dbus_property(obj):
764
return getattr(obj, "_dbus_is_property", False)
766
def _get_all_dbus_properties(self):
767
"""Returns a generator of (name, attribute) pairs
769
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
770
for cls in self.__class__.__mro__
772
inspect.getmembers(cls, self._is_dbus_property))
1347
774
def _get_dbus_property(self, interface_name, property_name):
1348
775
"""Returns a bound method if one exists which is a D-Bus
1349
776
property with the specified name and interface.
1351
for cls in self.__class__.__mro__:
1352
for name, value in inspect.getmembers(
1353
cls, self._is_dbus_thing("property")):
778
for cls in self.__class__.__mro__:
779
for name, value in (inspect.getmembers
780
(cls, self._is_dbus_property)):
1354
781
if (value._dbus_name == property_name
1355
782
and value._dbus_interface == interface_name):
1356
783
return value.__get__(self)
1358
785
# No such property
1359
raise DBusPropertyNotFound("{}:{}.{}".format(
1360
self.dbus_object_path, interface_name, property_name))
1363
def _get_all_interface_names(cls):
1364
"""Get a sequence of all interfaces supported by an object"""
1365
return (name for name in set(getattr(getattr(x, attr),
1366
"_dbus_interface", None)
1367
for x in (inspect.getmro(cls))
1369
if name is not None)
1371
@dbus.service.method(dbus.PROPERTIES_IFACE,
786
raise DBusPropertyNotFound(self.dbus_object_path + ":"
787
+ interface_name + "."
790
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1373
791
out_signature="v")
1374
792
def Get(self, interface_name, property_name):
1375
793
"""Standard D-Bus property Get() method, see D-Bus standard.
1500
885
except (AttributeError, xml.dom.DOMException,
1501
886
xml.parsers.expat.ExpatError) as error:
1502
887
logger.error("Failed to override Introspection method",
1508
dbus.OBJECT_MANAGER_IFACE
1509
except AttributeError:
1510
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1513
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1514
"""A D-Bus object with an ObjectManager.
1516
Classes inheriting from this exposes the standard
1517
GetManagedObjects call and the InterfacesAdded and
1518
InterfacesRemoved signals on the standard
1519
"org.freedesktop.DBus.ObjectManager" interface.
1521
Note: No signals are sent automatically; they must be sent
1524
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1525
out_signature="a{oa{sa{sv}}}")
1526
def GetManagedObjects(self):
1527
"""This function must be overridden"""
1528
raise NotImplementedError()
1530
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1531
signature="oa{sa{sv}}")
1532
def InterfacesAdded(self, object_path, interfaces_and_properties):
1535
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1536
def InterfacesRemoved(self, object_path, interfaces):
1539
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1541
path_keyword='object_path',
1542
connection_keyword='connection')
1543
def Introspect(self, object_path, connection):
1544
"""Overloading of standard D-Bus method.
1546
Override return argument name of GetManagedObjects to be
1547
"objpath_interfaces_and_properties"
1549
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1553
document = xml.dom.minidom.parseString(xmlstring)
1555
for if_tag in document.getElementsByTagName("interface"):
1556
# Fix argument name for the GetManagedObjects method
1557
if (if_tag.getAttribute("name")
1558
== dbus.OBJECT_MANAGER_IFACE):
1559
for cn in if_tag.getElementsByTagName("method"):
1560
if (cn.getAttribute("name")
1561
== "GetManagedObjects"):
1562
for arg in cn.getElementsByTagName("arg"):
1563
if (arg.getAttribute("direction")
1567
"objpath_interfaces"
1569
xmlstring = document.toxml("utf-8")
1571
except (AttributeError, xml.dom.DOMException,
1572
xml.parsers.expat.ExpatError) as error:
1573
logger.error("Failed to override Introspection method",
1578
def datetime_to_dbus(dt, variant_level=0):
892
def datetime_to_dbus (dt, variant_level=0):
1579
893
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1581
return dbus.String("", variant_level=variant_level)
1582
return dbus.String(dt.isoformat(), variant_level=variant_level)
1585
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1586
"""A class decorator; applied to a subclass of
1587
dbus.service.Object, it will add alternate D-Bus attributes with
1588
interface names according to the "alt_interface_names" mapping.
1591
@alternate_dbus_interfaces({"org.example.Interface":
1592
"net.example.AlternateInterface"})
1593
class SampleDBusObject(dbus.service.Object):
1594
@dbus.service.method("org.example.Interface")
1595
def SampleDBusMethod():
1598
The above "SampleDBusMethod" on "SampleDBusObject" will be
1599
reachable via two interfaces: "org.example.Interface" and
1600
"net.example.AlternateInterface", the latter of which will have
1601
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1602
"true", unless "deprecate" is passed with a False value.
1604
This works for methods and signals, and also for D-Bus properties
1605
(from DBusObjectWithProperties) and interfaces (from the
1606
dbus_interface_annotations decorator).
895
return dbus.String("", variant_level = variant_level)
896
return dbus.String(dt.isoformat(),
897
variant_level=variant_level)
900
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
902
"""Applied to an empty subclass of a D-Bus object, this metaclass
903
will add additional D-Bus attributes matching a certain pattern.
1610
for orig_interface_name, alt_interface_name in (
1611
alt_interface_names.items()):
1613
interface_names = set()
1614
# Go though all attributes of the class
1615
for attrname, attribute in inspect.getmembers(cls):
905
def __new__(mcs, name, bases, attr):
906
# Go through all the base classes which could have D-Bus
907
# methods, signals, or properties in them
908
for base in (b for b in bases
909
if issubclass(b, dbus.service.Object)):
910
# Go though all attributes of the base class
911
for attrname, attribute in inspect.getmembers(base):
1616
912
# Ignore non-D-Bus attributes, and D-Bus attributes
1617
913
# with the wrong interface name
1618
914
if (not hasattr(attribute, "_dbus_interface")
1619
or not attribute._dbus_interface.startswith(
1620
orig_interface_name)):
915
or not attribute._dbus_interface
916
.startswith("se.recompile.Mandos")):
1622
918
# Create an alternate D-Bus interface name based on
1623
919
# the current name
1624
alt_interface = attribute._dbus_interface.replace(
1625
orig_interface_name, alt_interface_name)
1626
interface_names.add(alt_interface)
920
alt_interface = (attribute._dbus_interface
921
.replace("se.recompile.Mandos",
922
"se.bsnet.fukt.Mandos"))
1627
923
# Is this a D-Bus signal?
1628
924
if getattr(attribute, "_dbus_is_signal", False):
1629
# Extract the original non-method undecorated
1630
# function by black magic
1631
if sys.version_info.major == 2:
1632
nonmethod_func = (dict(
925
# Extract the original non-method function by
927
nonmethod_func = (dict(
1633
928
zip(attribute.func_code.co_freevars,
1634
attribute.__closure__))
1635
["func"].cell_contents)
1637
nonmethod_func = (dict(
1638
zip(attribute.__code__.co_freevars,
1639
attribute.__closure__))
1640
["func"].cell_contents)
929
attribute.__closure__))["func"]
1641
931
# Create a new, but exactly alike, function
1642
932
# object, and decorate it to be a new D-Bus signal
1643
933
# with the alternate D-Bus interface name
1644
new_function = copy_function(nonmethod_func)
1645
new_function = (dbus.service.signal(
1647
attribute._dbus_signature)(new_function))
1648
# Copy annotations, if any
1650
new_function._dbus_annotations = dict(
1651
attribute._dbus_annotations)
1652
except AttributeError:
934
new_function = (dbus.service.signal
936
attribute._dbus_signature)
938
nonmethod_func.func_code,
939
nonmethod_func.func_globals,
940
nonmethod_func.func_name,
941
nonmethod_func.func_defaults,
942
nonmethod_func.func_closure)))
1655
943
# Define a creator of a function to call both the
1656
# original and alternate functions, so both the
1657
# original and alternate signals gets sent when
1658
# the function is called
944
# old and new functions, so both the old and new
945
# signals gets sent when the function is called
1659
946
def fixscope(func1, func2):
1660
947
"""This function is a scope container to pass
1661
948
func1 and func2 to the "call_both" function
1662
949
outside of its arguments"""
1664
@functools.wraps(func2)
1665
950
def call_both(*args, **kwargs):
1666
951
"""This function will emit two D-Bus
1667
952
signals by calling func1 and func2"""
1668
953
func1(*args, **kwargs)
1669
954
func2(*args, **kwargs)
1670
# Make wrapper function look like a D-Bus
1672
for name, attr in inspect.getmembers(func2):
1673
if name.startswith("_dbus_"):
1674
setattr(call_both, name, attr)
1676
955
return call_both
1677
956
# Create the "call_both" function and add it to
1679
attr[attrname] = fixscope(attribute, new_function)
958
attr[attrname] = fixscope(attribute,
1680
960
# Is this a D-Bus method?
1681
961
elif getattr(attribute, "_dbus_is_method", False):
1682
962
# Create a new, but exactly alike, function
1683
963
# object. Decorate it to be a new D-Bus method
1684
964
# with the alternate D-Bus interface name. Add it
1687
dbus.service.method(
1689
attribute._dbus_in_signature,
1690
attribute._dbus_out_signature)
1691
(copy_function(attribute)))
1692
# Copy annotations, if any
1694
attr[attrname]._dbus_annotations = dict(
1695
attribute._dbus_annotations)
1696
except AttributeError:
966
attr[attrname] = (dbus.service.method
968
attribute._dbus_in_signature,
969
attribute._dbus_out_signature)
971
(attribute.func_code,
972
attribute.func_globals,
974
attribute.func_defaults,
975
attribute.func_closure)))
1698
976
# Is this a D-Bus property?
1699
977
elif getattr(attribute, "_dbus_is_property", False):
1700
978
# Create a new, but exactly alike, function
1701
979
# object, and decorate it to be a new D-Bus
1702
980
# property with the alternate D-Bus interface
1703
981
# name. Add it to the class.
1704
attr[attrname] = (dbus_service_property(
1705
alt_interface, attribute._dbus_signature,
1706
attribute._dbus_access,
1707
attribute._dbus_get_args_options
1709
(copy_function(attribute)))
1710
# Copy annotations, if any
1712
attr[attrname]._dbus_annotations = dict(
1713
attribute._dbus_annotations)
1714
except AttributeError:
1716
# Is this a D-Bus interface?
1717
elif getattr(attribute, "_dbus_is_interface", False):
1718
# Create a new, but exactly alike, function
1719
# object. Decorate it to be a new D-Bus interface
1720
# with the alternate D-Bus interface name. Add it
1723
dbus_interface_annotations(alt_interface)
1724
(copy_function(attribute)))
1726
# Deprecate all alternate interfaces
1727
iname = "_AlternateDBusNames_interface_annotation{}"
1728
for interface_name in interface_names:
1730
@dbus_interface_annotations(interface_name)
1732
return {"org.freedesktop.DBus.Deprecated":
1734
# Find an unused name
1735
for aname in (iname.format(i)
1736
for i in itertools.count()):
1737
if aname not in attr:
1741
# Replace the class with a new subclass of it with
1742
# methods, signals, etc. as created above.
1743
if sys.version_info.major == 2:
1744
cls = type(b"{}Alternate".format(cls.__name__),
1747
cls = type("{}Alternate".format(cls.__name__),
1754
@alternate_dbus_interfaces({"se.recompile.Mandos":
1755
"se.bsnet.fukt.Mandos"})
982
attr[attrname] = (dbus_service_property
984
attribute._dbus_signature,
985
attribute._dbus_access,
987
._dbus_get_args_options
990
(attribute.func_code,
991
attribute.func_globals,
993
attribute.func_defaults,
994
attribute.func_closure)))
995
return type.__new__(mcs, name, bases, attr)
1756
998
class ClientDBus(Client, DBusObjectWithProperties):
1757
999
"""A Client class using D-Bus
1760
1002
dbus_object_path: dbus.ObjectPath
1761
1003
bus: dbus.SystemBus()
1764
1006
runtime_expansions = (Client.runtime_expansions
1765
+ ("dbus_object_path", ))
1767
_interface = "se.recompile.Mandos.Client"
1007
+ ("dbus_object_path",))
1769
1009
# dbus.service.Object doesn't use super(), so we can't either.
1771
def __init__(self, bus=None, *args, **kwargs):
1011
def __init__(self, bus = None, *args, **kwargs):
1773
1013
Client.__init__(self, *args, **kwargs)
1015
self._approvals_pending = 0
1774
1016
# Only now, when this client is initialized, can it show up on
1776
client_object_name = str(self.name).translate(
1018
client_object_name = unicode(self.name).translate(
1777
1019
{ord("."): ord("_"),
1778
1020
ord("-"): ord("_")})
1779
self.dbus_object_path = dbus.ObjectPath(
1780
"/clients/" + client_object_name)
1021
self.dbus_object_path = (dbus.ObjectPath
1022
("/clients/" + client_object_name))
1781
1023
DBusObjectWithProperties.__init__(self, self.bus,
1782
1024
self.dbus_object_path)
1784
def notifychangeproperty(transform_func, dbus_name,
1785
type_func=lambda x: x,
1787
invalidate_only=False,
1788
_interface=_interface):
1026
def notifychangeproperty(transform_func,
1027
dbus_name, type_func=lambda x: x,
1789
1029
""" Modify a variable so that it's a property which announces
1790
1030
its changes to DBus.
1792
1032
transform_fun: Function that takes a value and a variant_level
1793
1033
and transforms it to a D-Bus type.
1794
1034
dbus_name: D-Bus name of the variable
1946
1175
server to mandos-client
1950
1179
# Rejected - signal
1951
1180
@dbus.service.signal(_interface, signature="s")
1952
1181
def Rejected(self, reason):
1956
1185
# NeedApproval - signal
1957
1186
@dbus.service.signal(_interface, signature="tb")
1958
1187
def NeedApproval(self, timeout, default):
1960
1189
return self.need_approval()
1191
# NeRwequest - signal
1192
@dbus.service.signal(_interface, signature="s")
1193
def NewRequest(self, ip):
1195
Is sent after a client request a password.
1964
1201
# Approve - method
1965
1202
@dbus.service.method(_interface, in_signature="b")
1966
1203
def Approve(self, value):
1967
1204
self.approve(value)
1969
1206
# CheckedOK - method
1970
1207
@dbus.service.method(_interface)
1971
1208
def CheckedOK(self):
1972
1209
self.checked_ok()
1974
1211
# Enable - method
1975
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1976
1212
@dbus.service.method(_interface)
1977
1213
def Enable(self):
1981
1217
# StartChecker - method
1982
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1983
1218
@dbus.service.method(_interface)
1984
1219
def StartChecker(self):
1986
1221
self.start_checker()
1988
1223
# Disable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
1224
@dbus.service.method(_interface)
1991
1225
def Disable(self):
1995
1229
# StopChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
1230
@dbus.service.method(_interface)
1998
1231
def StopChecker(self):
1999
1232
self.stop_checker()
2003
1236
# ApprovalPending - property
2004
1237
@dbus_service_property(_interface, signature="b", access="read")
2005
1238
def ApprovalPending_dbus_property(self):
2006
1239
return dbus.Boolean(bool(self.approvals_pending))
2008
1241
# ApprovedByDefault - property
2009
@dbus_service_property(_interface,
1242
@dbus_service_property(_interface, signature="b",
2011
1243
access="readwrite")
2012
1244
def ApprovedByDefault_dbus_property(self, value=None):
2013
1245
if value is None: # get
2014
1246
return dbus.Boolean(self.approved_by_default)
2015
1247
self.approved_by_default = bool(value)
2017
1249
# ApprovalDelay - property
2018
@dbus_service_property(_interface,
1250
@dbus_service_property(_interface, signature="t",
2020
1251
access="readwrite")
2021
1252
def ApprovalDelay_dbus_property(self, value=None):
2022
1253
if value is None: # get
2023
return dbus.UInt64(self.approval_delay.total_seconds()
1254
return dbus.UInt64(self.approval_delay_milliseconds())
2025
1255
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2027
1257
# ApprovalDuration - property
2028
@dbus_service_property(_interface,
1258
@dbus_service_property(_interface, signature="t",
2030
1259
access="readwrite")
2031
1260
def ApprovalDuration_dbus_property(self, value=None):
2032
1261
if value is None: # get
2033
return dbus.UInt64(self.approval_duration.total_seconds()
1262
return dbus.UInt64(timedelta_to_milliseconds(
1263
self.approval_duration))
2035
1264
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2037
1266
# Name - property
2039
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2040
1267
@dbus_service_property(_interface, signature="s", access="read")
2041
1268
def Name_dbus_property(self):
2042
1269
return dbus.String(self.name)
2046
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2047
@dbus_service_property(_interface, signature="s", access="read")
2048
def KeyID_dbus_property(self):
2049
return dbus.String(self.key_id)
2051
1271
# Fingerprint - property
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
1272
@dbus_service_property(_interface, signature="s", access="read")
2055
1273
def Fingerprint_dbus_property(self):
2056
1274
return dbus.String(self.fingerprint)
2058
1276
# Host - property
2059
@dbus_service_property(_interface,
1277
@dbus_service_property(_interface, signature="s",
2061
1278
access="readwrite")
2062
1279
def Host_dbus_property(self, value=None):
2063
1280
if value is None: # get
2064
1281
return dbus.String(self.host)
2065
self.host = str(value)
2067
1284
# Created - property
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
1285
@dbus_service_property(_interface, signature="s", access="read")
2071
1286
def Created_dbus_property(self):
2072
1287
return datetime_to_dbus(self.created)
2074
1289
# LastEnabled - property
2075
1290
@dbus_service_property(_interface, signature="s", access="read")
2076
1291
def LastEnabled_dbus_property(self):
2077
1292
return datetime_to_dbus(self.last_enabled)
2079
1294
# Enabled - property
2080
@dbus_service_property(_interface,
1295
@dbus_service_property(_interface, signature="b",
2082
1296
access="readwrite")
2083
1297
def Enabled_dbus_property(self, value=None):
2084
1298
if value is None: # get
2091
1305
# LastCheckedOK - property
2092
@dbus_service_property(_interface,
1306
@dbus_service_property(_interface, signature="s",
2094
1307
access="readwrite")
2095
1308
def LastCheckedOK_dbus_property(self, value=None):
2096
1309
if value is not None:
2097
1310
self.checked_ok()
2099
1312
return datetime_to_dbus(self.last_checked_ok)
2101
# LastCheckerStatus - property
2102
@dbus_service_property(_interface, signature="n", access="read")
2103
def LastCheckerStatus_dbus_property(self):
2104
return dbus.Int16(self.last_checker_status)
2106
1314
# Expires - property
2107
1315
@dbus_service_property(_interface, signature="s", access="read")
2108
1316
def Expires_dbus_property(self):
2109
1317
return datetime_to_dbus(self.expires)
2111
1319
# LastApprovalRequest - property
2112
1320
@dbus_service_property(_interface, signature="s", access="read")
2113
1321
def LastApprovalRequest_dbus_property(self):
2114
1322
return datetime_to_dbus(self.last_approval_request)
2116
1324
# Timeout - property
2117
@dbus_service_property(_interface,
1325
@dbus_service_property(_interface, signature="t",
2119
1326
access="readwrite")
2120
1327
def Timeout_dbus_property(self, value=None):
2121
1328
if value is None: # get
2122
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2123
old_timeout = self.timeout
1329
return dbus.UInt64(self.timeout_milliseconds())
2124
1330
self.timeout = datetime.timedelta(0, 0, 0, value)
2125
# Reschedule disabling
2127
now = datetime.datetime.utcnow()
2128
self.expires += self.timeout - old_timeout
2129
if self.expires <= now:
2130
# The timeout has passed
2133
if (getattr(self, "disable_initiator_tag", None)
2136
GLib.source_remove(self.disable_initiator_tag)
2137
self.disable_initiator_tag = GLib.timeout_add(
2138
int((self.expires - now).total_seconds() * 1000),
1331
if getattr(self, "disable_initiator_tag", None) is None:
1333
# Reschedule timeout
1334
gobject.source_remove(self.disable_initiator_tag)
1335
self.disable_initiator_tag = None
1337
time_to_die = timedelta_to_milliseconds((self
1342
if time_to_die <= 0:
1343
# The timeout has passed
1346
self.expires = (datetime.datetime.utcnow()
1347
+ datetime.timedelta(milliseconds =
1349
self.disable_initiator_tag = (gobject.timeout_add
1350
(time_to_die, self.disable))
2141
1352
# ExtendedTimeout - property
2142
@dbus_service_property(_interface,
1353
@dbus_service_property(_interface, signature="t",
2144
1354
access="readwrite")
2145
1355
def ExtendedTimeout_dbus_property(self, value=None):
2146
1356
if value is None: # get
2147
return dbus.UInt64(self.extended_timeout.total_seconds()
1357
return dbus.UInt64(self.extended_timeout_milliseconds())
2149
1358
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2151
1360
# Interval - property
2152
@dbus_service_property(_interface,
1361
@dbus_service_property(_interface, signature="t",
2154
1362
access="readwrite")
2155
1363
def Interval_dbus_property(self, value=None):
2156
1364
if value is None: # get
2157
return dbus.UInt64(self.interval.total_seconds() * 1000)
1365
return dbus.UInt64(self.interval_milliseconds())
2158
1366
self.interval = datetime.timedelta(0, 0, 0, value)
2159
1367
if getattr(self, "checker_initiator_tag", None) is None:
2161
1369
if self.enabled:
2162
1370
# Reschedule checker run
2163
GLib.source_remove(self.checker_initiator_tag)
2164
self.checker_initiator_tag = GLib.timeout_add(
2165
value, self.start_checker)
2166
self.start_checker() # Start one now, too
1371
gobject.source_remove(self.checker_initiator_tag)
1372
self.checker_initiator_tag = (gobject.timeout_add
1373
(value, self.start_checker))
1374
self.start_checker() # Start one now, too
2168
1376
# Checker - property
2169
@dbus_service_property(_interface,
1377
@dbus_service_property(_interface, signature="s",
2171
1378
access="readwrite")
2172
1379
def Checker_dbus_property(self, value=None):
2173
1380
if value is None: # get
2174
1381
return dbus.String(self.checker_command)
2175
self.checker_command = str(value)
1382
self.checker_command = value
2177
1384
# CheckerRunning - property
2178
@dbus_service_property(_interface,
1385
@dbus_service_property(_interface, signature="b",
2180
1386
access="readwrite")
2181
1387
def CheckerRunning_dbus_property(self, value=None):
2182
1388
if value is None: # get
2223
1421
if data[0] == 'data':
2225
1423
if data[0] == 'function':
2227
1424
def func(*args, **kwargs):
2228
1425
self._pipe.send(('funcall', name, args, kwargs))
2229
1426
return self._pipe.recv()[1]
2233
1429
def __setattr__(self, name, value):
2234
1430
if name == '_pipe':
2235
1431
return super(ProxyClient, self).__setattr__(name, value)
2236
1432
self._pipe.send(('setattr', name, value))
1435
class ClientDBusTransitional(ClientDBus):
1436
__metaclass__ = AlternateDBusNamesMetaclass
2239
1439
class ClientHandler(socketserver.BaseRequestHandler, object):
2240
1440
"""A class to handle client connections.
2242
1442
Instantiated once for each connection to handle it.
2243
1443
Note: This will run in its own forked process."""
2245
1445
def handle(self):
2246
1446
with contextlib.closing(self.server.child_pipe) as child_pipe:
2247
1447
logger.info("TCP connection from: %s",
2248
str(self.client_address))
1448
unicode(self.client_address))
2249
1449
logger.debug("Pipe FD: %d",
2250
1450
self.server.child_pipe.fileno())
2252
session = gnutls.ClientSession(self.request)
2254
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2255
# "+AES-256-CBC", "+SHA1",
2256
# "+COMP-NULL", "+CTYPE-OPENPGP",
1452
session = (gnutls.connection
1453
.ClientSession(self.request,
1455
.X509Credentials()))
1457
# Note: gnutls.connection.X509Credentials is really a
1458
# generic GnuTLS certificate credentials object so long as
1459
# no X.509 keys are added to it. Therefore, we can use it
1460
# here despite using OpenPGP certificates.
1462
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1463
# "+AES-256-CBC", "+SHA1",
1464
# "+COMP-NULL", "+CTYPE-OPENPGP",
2258
1466
# Use a fallback default, since this MUST be set.
2259
1467
priority = self.server.gnutls_priority
2260
1468
if priority is None:
2261
1469
priority = "NORMAL"
2262
gnutls.priority_set_direct(session._c_object,
2263
priority.encode("utf-8"),
1470
(gnutls.library.functions
1471
.gnutls_priority_set_direct(session._c_object,
2266
1474
# Start communication using the Mandos protocol
2267
1475
# Get protocol number
2268
1476
line = self.request.makefile().readline()
2269
1477
logger.debug("Protocol version: %r", line)
2271
1479
if int(line.strip().split()[0]) > 1:
2272
raise RuntimeError(line)
2273
1481
except (ValueError, IndexError, RuntimeError) as error:
2274
1482
logger.error("Unknown protocol version: %s", error)
2277
1485
# Start GnuTLS connection
2279
1487
session.handshake()
2280
except gnutls.Error as error:
1488
except gnutls.errors.GNUTLSError as error:
2281
1489
logger.warning("Handshake failed: %s", error)
2282
1490
# Do not run session.bye() here: the session is not
2283
1491
# established. Just abandon the request.
2285
1493
logger.debug("Handshake succeeded")
2287
1495
approval_required = False
2289
if gnutls.has_rawpk:
2292
key_id = self.key_id(
2293
self.peer_certificate(session))
2294
except (TypeError, gnutls.Error) as error:
2295
logger.warning("Bad certificate: %s", error)
2297
logger.debug("Key ID: %s", key_id)
2302
fpr = self.fingerprint(
2303
self.peer_certificate(session))
2304
except (TypeError, gnutls.Error) as error:
2305
logger.warning("Bad certificate: %s", error)
2307
logger.debug("Fingerprint: %s", fpr)
2310
client = ProxyClient(child_pipe, key_id, fpr,
1498
fpr = self.fingerprint(self.peer_certificate
1501
gnutls.errors.GNUTLSError) as error:
1502
logger.warning("Bad certificate: %s", error)
1504
logger.debug("Fingerprint: %s", fpr)
1507
client = ProxyClient(child_pipe, fpr,
2311
1508
self.client_address)
2312
1509
except KeyError:
1512
if self.server.use_dbus:
1514
client.NewRequest(str(self.client_address))
2315
1516
if client.approval_delay:
2316
1517
delay = client.approval_delay
2317
1518
client.approvals_pending += 1
2318
1519
approval_required = True
2321
1522
if not client.enabled:
2322
1523
logger.info("Client %s is disabled",
2324
1525
if self.server.use_dbus:
2325
1526
# Emit D-Bus signal
2326
1527
client.Rejected("Disabled")
2329
1530
if client.approved or not client.approval_delay:
2330
# We are approved or approval is disabled
1531
#We are approved or approval is disabled
2332
1533
elif client.approved is None:
2333
1534
logger.info("Client %s needs approval",
2366
1569
delay -= time2 - time
2369
session.send(client.secret)
2370
except gnutls.Error as error:
2371
logger.warning("gnutls send failed",
1572
while sent_size < len(client.secret):
1574
sent = session.send(client.secret[sent_size:])
1575
except gnutls.errors.GNUTLSError as error:
1576
logger.warning("gnutls send failed")
1578
logger.debug("Sent: %d, remaining: %d",
1579
sent, len(client.secret)
1580
- (sent_size + sent))
2375
1583
logger.info("Sending secret to %s", client.name)
2376
1584
# bump the timeout using extended_timeout
2377
client.bump_timeout(client.extended_timeout)
1585
client.checked_ok(client.extended_timeout)
2378
1586
if self.server.use_dbus:
2379
1587
# Emit D-Bus signal
2380
1588
client.GotSecret()
2383
1591
if approval_required:
2384
1592
client.approvals_pending -= 1
2387
except gnutls.Error as error:
2388
logger.warning("GnuTLS bye failed",
1595
except gnutls.errors.GNUTLSError as error:
1596
logger.warning("GnuTLS bye failed")
2392
1599
def peer_certificate(session):
2393
"Return the peer's certificate as a bytestring"
2395
cert_type = gnutls.certificate_type_get2(session._c_object,
2397
except AttributeError:
2398
cert_type = gnutls.certificate_type_get(session._c_object)
2399
if gnutls.has_rawpk:
2400
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2402
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2403
# If not a valid certificate type...
2404
if cert_type not in valid_cert_types:
2405
logger.info("Cert type %r not in %r", cert_type,
2407
# ...return invalid data
1600
"Return the peer's OpenPGP certificate as a bytestring"
1601
# If not an OpenPGP certificate...
1602
if (gnutls.library.functions
1603
.gnutls_certificate_type_get(session._c_object)
1604
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1605
# ...do the normal thing
1606
return session.peer_certificate
2409
1607
list_size = ctypes.c_uint(1)
2410
cert_list = (gnutls.certificate_get_peers
1608
cert_list = (gnutls.library.functions
1609
.gnutls_certificate_get_peers
2411
1610
(session._c_object, ctypes.byref(list_size)))
2412
1611
if not bool(cert_list) and list_size.value != 0:
2413
raise gnutls.Error("error getting peer certificate")
1612
raise gnutls.errors.GNUTLSError("error getting peer"
2414
1614
if list_size.value == 0:
2416
1616
cert = cert_list[0]
2417
1617
return ctypes.string_at(cert.data, cert.size)
2420
def key_id(certificate):
2421
"Convert a certificate bytestring to a hexdigit key ID"
2422
# New GnuTLS "datum" with the public key
2423
datum = gnutls.datum_t(
2424
ctypes.cast(ctypes.c_char_p(certificate),
2425
ctypes.POINTER(ctypes.c_ubyte)),
2426
ctypes.c_uint(len(certificate)))
2427
# XXX all these need to be created in the gnutls "module"
2428
# New empty GnuTLS certificate
2429
pubkey = gnutls.pubkey_t()
2430
gnutls.pubkey_init(ctypes.byref(pubkey))
2431
# Import the raw public key into the certificate
2432
gnutls.pubkey_import(pubkey,
2433
ctypes.byref(datum),
2434
gnutls.X509_FMT_DER)
2435
# New buffer for the key ID
2436
buf = ctypes.create_string_buffer(32)
2437
buf_len = ctypes.c_size_t(len(buf))
2438
# Get the key ID from the raw public key into the buffer
2439
gnutls.pubkey_get_key_id(pubkey,
2440
gnutls.KEYID_USE_SHA256,
2441
ctypes.cast(ctypes.byref(buf),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.byref(buf_len))
2444
# Deinit the certificate
2445
gnutls.pubkey_deinit(pubkey)
2447
# Convert the buffer to a Python bytestring
2448
key_id = ctypes.string_at(buf, buf_len.value)
2449
# Convert the bytestring to hexadecimal notation
2450
hex_key_id = binascii.hexlify(key_id).upper()
2454
1620
def fingerprint(openpgp):
2455
1621
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2456
1622
# New GnuTLS "datum" with the OpenPGP public key
2457
datum = gnutls.datum_t(
2458
ctypes.cast(ctypes.c_char_p(openpgp),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.c_uint(len(openpgp)))
1623
datum = (gnutls.library.types
1624
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1627
ctypes.c_uint(len(openpgp))))
2461
1628
# New empty GnuTLS certificate
2462
crt = gnutls.openpgp_crt_t()
2463
gnutls.openpgp_crt_init(ctypes.byref(crt))
1629
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1630
(gnutls.library.functions
1631
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2464
1632
# Import the OpenPGP public key into the certificate
2465
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2466
gnutls.OPENPGP_FMT_RAW)
1633
(gnutls.library.functions
1634
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1635
gnutls.library.constants
1636
.GNUTLS_OPENPGP_FMT_RAW))
2467
1637
# Verify the self signature in the key
2468
1638
crtverify = ctypes.c_uint()
2469
gnutls.openpgp_crt_verify_self(crt, 0,
2470
ctypes.byref(crtverify))
1639
(gnutls.library.functions
1640
.gnutls_openpgp_crt_verify_self(crt, 0,
1641
ctypes.byref(crtverify)))
2471
1642
if crtverify.value != 0:
2472
gnutls.openpgp_crt_deinit(crt)
2473
raise gnutls.CertificateSecurityError(code
1643
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1644
raise (gnutls.errors.CertificateSecurityError
2475
1646
# New buffer for the fingerprint
2476
1647
buf = ctypes.create_string_buffer(20)
2477
1648
buf_len = ctypes.c_size_t()
2478
1649
# Get the fingerprint from the certificate into the buffer
2479
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2480
ctypes.byref(buf_len))
1650
(gnutls.library.functions
1651
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1652
ctypes.byref(buf_len)))
2481
1653
# Deinit the certificate
2482
gnutls.openpgp_crt_deinit(crt)
1654
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2483
1655
# Convert the buffer to a Python bytestring
2484
1656
fpr = ctypes.string_at(buf, buf_len.value)
2485
1657
# Convert the bytestring to hexadecimal notation
2490
1662
class MultiprocessingMixIn(object):
2491
1663
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2493
1664
def sub_process_main(self, request, address):
2495
1666
self.finish_request(request, address)
2497
1668
self.handle_error(request, address)
2498
1669
self.close_request(request)
2500
1671
def process_request(self, request, address):
2501
1672
"""Start a new process to process the request."""
2502
proc = multiprocessing.Process(target=self.sub_process_main,
2503
args=(request, address))
1673
proc = multiprocessing.Process(target = self.sub_process_main,
2508
1680
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2509
1681
""" adds a pipe to the MixIn """
2511
1682
def process_request(self, request, client_address):
2512
1683
"""Overrides and wraps the original process_request().
2514
1685
This function creates a new pipe in self.pipe
2516
1687
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2518
1689
proc = MultiprocessingMixIn.process_request(self, request,
2519
1690
client_address)
2520
1691
self.child_pipe.close()
2521
1692
self.add_pipe(parent_pipe, proc)
2523
1694
def add_pipe(self, parent_pipe, proc):
2524
1695
"""Dummy function; override as necessary"""
2525
raise NotImplementedError()
1696
raise NotImplementedError
2528
1699
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2529
1700
socketserver.TCPServer, object):
2530
1701
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2533
1704
enabled: Boolean; whether this server is activated yet
2534
1705
interface: None or a network interface name (string)
2535
1706
use_ipv6: Boolean; to use IPv6 or not
2538
1708
def __init__(self, server_address, RequestHandlerClass,
2542
"""If socketfd is set, use that file descriptor instead of
2543
creating a new one with socket.socket().
1709
interface=None, use_ipv6=True):
2545
1710
self.interface = interface
2547
1712
self.address_family = socket.AF_INET6
2548
if socketfd is not None:
2549
# Save the file descriptor
2550
self.socketfd = socketfd
2551
# Save the original socket.socket() function
2552
self.socket_socket = socket.socket
2554
# To implement --socket, we monkey patch socket.socket.
2556
# (When socketserver.TCPServer is a new-style class, we
2557
# could make self.socket into a property instead of monkey
2558
# patching socket.socket.)
2560
# Create a one-time-only replacement for socket.socket()
2561
@functools.wraps(socket.socket)
2562
def socket_wrapper(*args, **kwargs):
2563
# Restore original function so subsequent calls are
2565
socket.socket = self.socket_socket
2566
del self.socket_socket
2567
# This time only, return a new socket object from the
2568
# saved file descriptor.
2569
return socket.fromfd(self.socketfd, *args, **kwargs)
2570
# Replace socket.socket() function with wrapper
2571
socket.socket = socket_wrapper
2572
# The socketserver.TCPServer.__init__ will call
2573
# socket.socket(), which might be our replacement,
2574
# socket_wrapper(), if socketfd was set.
2575
1713
socketserver.TCPServer.__init__(self, server_address,
2576
1714
RequestHandlerClass)
2578
1715
def server_bind(self):
2579
1716
"""This overrides the normal server_bind() function
2580
1717
to bind to an interface if one was specified, and also NOT to
2581
1718
bind to an address or port if they were not specified."""
2582
global SO_BINDTODEVICE
2583
1719
if self.interface is not None:
2584
1720
if SO_BINDTODEVICE is None:
2585
# Fall back to a hard-coded value which seems to be
2587
logger.warning("SO_BINDTODEVICE not found, trying 25")
2588
SO_BINDTODEVICE = 25
2590
self.socket.setsockopt(
2591
socket.SOL_SOCKET, SO_BINDTODEVICE,
2592
(self.interface + "\0").encode("utf-8"))
2593
except socket.error as error:
2594
if error.errno == errno.EPERM:
2595
logger.error("No permission to bind to"
2596
" interface %s", self.interface)
2597
elif error.errno == errno.ENOPROTOOPT:
2598
logger.error("SO_BINDTODEVICE not available;"
2599
" cannot bind to interface %s",
2601
elif error.errno == errno.ENODEV:
2602
logger.error("Interface %s does not exist,"
2603
" cannot bind", self.interface)
1721
logger.error("SO_BINDTODEVICE does not exist;"
1722
" cannot bind to interface %s",
1726
self.socket.setsockopt(socket.SOL_SOCKET,
1730
except socket.error as error:
1731
if error[0] == errno.EPERM:
1732
logger.error("No permission to"
1733
" bind to interface %s",
1735
elif error[0] == errno.ENOPROTOOPT:
1736
logger.error("SO_BINDTODEVICE not available;"
1737
" cannot bind to interface %s",
2606
1741
# Only bind(2) the socket if we really need to.
2607
1742
if self.server_address[0] or self.server_address[1]:
2608
1743
if not self.server_address[0]:
2609
1744
if self.address_family == socket.AF_INET6:
2610
any_address = "::" # in6addr_any
1745
any_address = "::" # in6addr_any
2612
any_address = "0.0.0.0" # INADDR_ANY
1747
any_address = socket.INADDR_ANY
2613
1748
self.server_address = (any_address,
2614
1749
self.server_address[1])
2615
1750
elif not self.server_address[1]:
2616
self.server_address = (self.server_address[0], 0)
1751
self.server_address = (self.server_address[0],
2617
1753
# if self.interface:
2618
1754
# self.server_address = (self.server_address[0],
2722
1858
funcname = request[1]
2723
1859
args = request[2]
2724
1860
kwargs = request[3]
2726
1862
parent_pipe.send(('data', getattr(client_object,
2727
1863
funcname)(*args,
2730
1866
if command == 'getattr':
2731
1867
attrname = request[1]
2732
if isinstance(client_object.__getattribute__(attrname),
2733
collections.Callable):
2734
parent_pipe.send(('function', ))
1868
if callable(client_object.__getattribute__(attrname)):
1869
parent_pipe.send(('function',))
2737
'data', client_object.__getattribute__(attrname)))
1871
parent_pipe.send(('data', client_object
1872
.__getattribute__(attrname)))
2739
1874
if command == 'setattr':
2740
1875
attrname = request[1]
2741
1876
value = request[2]
2742
1877
setattr(client_object, attrname, value)
2747
def rfc3339_duration_to_delta(duration):
2748
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2750
>>> rfc3339_duration_to_delta("P7D")
2751
datetime.timedelta(7)
2752
>>> rfc3339_duration_to_delta("PT60S")
2753
datetime.timedelta(0, 60)
2754
>>> rfc3339_duration_to_delta("PT60M")
2755
datetime.timedelta(0, 3600)
2756
>>> rfc3339_duration_to_delta("PT24H")
2757
datetime.timedelta(1)
2758
>>> rfc3339_duration_to_delta("P1W")
2759
datetime.timedelta(7)
2760
>>> rfc3339_duration_to_delta("PT5M30S")
2761
datetime.timedelta(0, 330)
2762
>>> rfc3339_duration_to_delta("P1DT3M20S")
2763
datetime.timedelta(1, 200)
2766
# Parsing an RFC 3339 duration with regular expressions is not
2767
# possible - there would have to be multiple places for the same
2768
# values, like seconds. The current code, while more esoteric, is
2769
# cleaner without depending on a parsing library. If Python had a
2770
# built-in library for parsing we would use it, but we'd like to
2771
# avoid excessive use of external libraries.
2773
# New type for defining tokens, syntax, and semantics all-in-one
2774
Token = collections.namedtuple("Token", (
2775
"regexp", # To match token; if "value" is not None, must have
2776
# a "group" containing digits
2777
"value", # datetime.timedelta or None
2778
"followers")) # Tokens valid after this token
2779
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2780
# the "duration" ABNF definition in RFC 3339, Appendix A.
2781
token_end = Token(re.compile(r"$"), None, frozenset())
2782
token_second = Token(re.compile(r"(\d+)S"),
2783
datetime.timedelta(seconds=1),
2784
frozenset((token_end, )))
2785
token_minute = Token(re.compile(r"(\d+)M"),
2786
datetime.timedelta(minutes=1),
2787
frozenset((token_second, token_end)))
2788
token_hour = Token(re.compile(r"(\d+)H"),
2789
datetime.timedelta(hours=1),
2790
frozenset((token_minute, token_end)))
2791
token_time = Token(re.compile(r"T"),
2793
frozenset((token_hour, token_minute,
2795
token_day = Token(re.compile(r"(\d+)D"),
2796
datetime.timedelta(days=1),
2797
frozenset((token_time, token_end)))
2798
token_month = Token(re.compile(r"(\d+)M"),
2799
datetime.timedelta(weeks=4),
2800
frozenset((token_day, token_end)))
2801
token_year = Token(re.compile(r"(\d+)Y"),
2802
datetime.timedelta(weeks=52),
2803
frozenset((token_month, token_end)))
2804
token_week = Token(re.compile(r"(\d+)W"),
2805
datetime.timedelta(weeks=1),
2806
frozenset((token_end, )))
2807
token_duration = Token(re.compile(r"P"), None,
2808
frozenset((token_year, token_month,
2809
token_day, token_time,
2811
# Define starting values:
2813
value = datetime.timedelta()
2815
# Following valid tokens
2816
followers = frozenset((token_duration, ))
2817
# String left to parse
2819
# Loop until end token is found
2820
while found_token is not token_end:
2821
# Search for any currently valid tokens
2822
for token in followers:
2823
match = token.regexp.match(s)
2824
if match is not None:
2826
if token.value is not None:
2827
# Value found, parse digits
2828
factor = int(match.group(1), 10)
2829
# Add to value so far
2830
value += factor * token.value
2831
# Strip token from string
2832
s = token.regexp.sub("", s, 1)
2835
# Set valid next tokens
2836
followers = found_token.followers
2839
# No currently valid tokens were found
2840
raise ValueError("Invalid RFC 3339 duration: {!r}"
2846
1882
def string_to_delta(interval):
2847
1883
"""Parse a string and return a datetime.timedelta
2849
1885
>>> string_to_delta('7d')
2850
1886
datetime.timedelta(7)
2851
1887
>>> string_to_delta('60s')
2946
1976
parser.add_argument("--no-dbus", action="store_false",
2947
1977
dest="use_dbus", help="Do not provide D-Bus"
2948
" system bus interface", default=None)
1978
" system bus interface")
2949
1979
parser.add_argument("--no-ipv6", action="store_false",
2950
dest="use_ipv6", help="Do not use IPv6",
1980
dest="use_ipv6", help="Do not use IPv6")
2952
1981
parser.add_argument("--no-restore", action="store_false",
2953
1982
dest="restore", help="Do not restore stored"
2954
" state", default=None)
2955
parser.add_argument("--socket", type=int,
2956
help="Specify a file descriptor to a network"
2957
" socket to use instead of creating one")
2958
1984
parser.add_argument("--statedir", metavar="DIR",
2959
1985
help="Directory to save/restore state in")
2960
parser.add_argument("--foreground", action="store_true",
2961
help="Run in foreground", default=None)
2962
parser.add_argument("--no-zeroconf", action="store_false",
2963
dest="zeroconf", help="Do not use Zeroconf",
2966
1987
options = parser.parse_args()
2968
1989
if options.check:
2970
fail_count, test_count = doctest.testmod()
2971
sys.exit(os.EX_OK if fail_count == 0 else 1)
2973
1994
# Default values for config file for server-global settings
2974
if gnutls.has_rawpk:
2975
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2976
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2978
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2979
":+SIGN-DSA-SHA256")
2980
server_defaults = {"interface": "",
2984
"priority": priority,
2985
"servicename": "Mandos",
2991
"statedir": "/var/lib/mandos",
2992
"foreground": "False",
1995
server_defaults = { "interface": "",
2000
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2001
"servicename": "Mandos",
2006
"statedir": "/var/lib/mandos"
2997
2009
# Parse config file for server-global settings
2998
2010
server_config = configparser.SafeConfigParser(server_defaults)
2999
2011
del server_defaults
3000
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2012
server_config.read(os.path.join(options.configdir,
3001
2014
# Convert the SafeConfigParser object to a dict
3002
2015
server_settings = server_config.defaults()
3003
2016
# Use the appropriate methods on the non-string config options
3004
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3005
"foreground", "zeroconf"):
2017
for option in ("debug", "use_dbus", "use_ipv6"):
3006
2018
server_settings[option] = server_config.getboolean("DEFAULT",
3008
2020
if server_settings["port"]:
3009
2021
server_settings["port"] = server_config.getint("DEFAULT",
3011
if server_settings["socket"]:
3012
server_settings["socket"] = server_config.getint("DEFAULT",
3014
# Later, stdin will, and stdout and stderr might, be dup'ed
3015
# over with an opened os.devnull. But we don't want this to
3016
# happen with a supplied network socket.
3017
if 0 <= server_settings["socket"] <= 2:
3018
server_settings["socket"] = os.dup(server_settings
3020
2023
del server_config
3022
2025
# Override the settings from the config file with command line
3023
2026
# options, if set.
3024
2027
for option in ("interface", "address", "port", "debug",
3025
"priority", "servicename", "configdir", "use_dbus",
3026
"use_ipv6", "debuglevel", "restore", "statedir",
3027
"socket", "foreground", "zeroconf"):
2028
"priority", "servicename", "configdir",
2029
"use_dbus", "use_ipv6", "debuglevel", "restore",
3028
2031
value = getattr(options, option)
3029
2032
if value is not None:
3030
2033
server_settings[option] = value
3032
2035
# Force all strings to be unicode
3033
2036
for option in server_settings.keys():
3034
if isinstance(server_settings[option], bytes):
3035
server_settings[option] = (server_settings[option]
3037
# Force all boolean options to be boolean
3038
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3039
"foreground", "zeroconf"):
3040
server_settings[option] = bool(server_settings[option])
3041
# Debug implies foreground
3042
if server_settings["debug"]:
3043
server_settings["foreground"] = True
2037
if type(server_settings[option]) is str:
2038
server_settings[option] = unicode(server_settings[option])
3044
2039
# Now we have our good server settings in "server_settings"
3046
2041
##################################################################
3048
if (not server_settings["zeroconf"]
3049
and not (server_settings["port"]
3050
or server_settings["socket"] != "")):
3051
parser.error("Needs port or socket to work without Zeroconf")
3053
2043
# For convenience
3054
2044
debug = server_settings["debug"]
3055
2045
debuglevel = server_settings["debuglevel"]
3057
2047
use_ipv6 = server_settings["use_ipv6"]
3058
2048
stored_state_path = os.path.join(server_settings["statedir"],
3059
2049
stored_state_file)
3060
foreground = server_settings["foreground"]
3061
zeroconf = server_settings["zeroconf"]
3064
initlogger(debug, logging.DEBUG)
2052
initlogger(logging.DEBUG)
3066
2054
if not debuglevel:
3069
2057
level = getattr(logging, debuglevel.upper())
3070
initlogger(debug, level)
3072
2060
if server_settings["servicename"] != "Mandos":
3073
syslogger.setFormatter(
3074
logging.Formatter('Mandos ({}) [%(process)d]:'
3075
' %(levelname)s: %(message)s'.format(
3076
server_settings["servicename"])))
2061
syslogger.setFormatter(logging.Formatter
2062
('Mandos (%s) [%%(process)d]:'
2063
' %%(levelname)s: %%(message)s'
2064
% server_settings["servicename"]))
3078
2066
# Parse config file with clients
3079
client_config = configparser.SafeConfigParser(Client
2067
client_defaults = { "timeout": "5m",
2068
"extended_timeout": "15m",
2070
"checker": "fping -q -- %%(host)s",
2072
"approval_delay": "0s",
2073
"approval_duration": "1s",
2075
client_config = configparser.SafeConfigParser(client_defaults)
3081
2076
client_config.read(os.path.join(server_settings["configdir"],
3082
2077
"clients.conf"))
3084
2079
global mandos_dbus_service
3085
2080
mandos_dbus_service = None
3088
if server_settings["socket"] != "":
3089
socketfd = server_settings["socket"]
3090
tcp_server = MandosServer(
3091
(server_settings["address"], server_settings["port"]),
3093
interface=(server_settings["interface"] or None),
3095
gnutls_priority=server_settings["priority"],
3099
pidfilename = "/run/mandos.pid"
3100
if not os.path.isdir("/run/."):
3101
pidfilename = "/var/run/mandos.pid"
3104
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3105
except IOError as e:
3106
logger.error("Could not open file %r", pidfilename,
3109
for name, group in (("_mandos", "_mandos"),
3110
("mandos", "mandos"),
3111
("nobody", "nogroup")):
3113
uid = pwd.getpwnam(name).pw_uid
3114
gid = pwd.getpwnam(group).pw_gid
2082
tcp_server = MandosServer((server_settings["address"],
2083
server_settings["port"]),
2085
interface=(server_settings["interface"]
2089
server_settings["priority"],
2092
pidfilename = "/var/run/mandos.pid"
2094
pidfile = open(pidfilename, "w")
2096
logger.error("Could not open file %r", pidfilename)
2099
uid = pwd.getpwnam("_mandos").pw_uid
2100
gid = pwd.getpwnam("_mandos").pw_gid
2103
uid = pwd.getpwnam("mandos").pw_uid
2104
gid = pwd.getpwnam("mandos").pw_gid
3116
2105
except KeyError:
2107
uid = pwd.getpwnam("nobody").pw_uid
2108
gid = pwd.getpwnam("nobody").pw_gid
3125
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3127
2115
except OSError as error:
3128
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3129
.format(uid, gid, os.strerror(error.errno)))
3130
if error.errno != errno.EPERM:
2116
if error[0] != errno.EPERM:
3134
2120
# Enable all possible GnuTLS debugging
3136
2122
# "Use a log level over 10 to enable all debugging options."
3137
2123
# - GnuTLS manual
3138
gnutls.global_set_log_level(11)
2124
gnutls.library.functions.gnutls_global_set_log_level(11)
2126
@gnutls.library.types.gnutls_log_func
3141
2127
def debug_gnutls(level, string):
3142
2128
logger.debug("GnuTLS: %s", string[:-1])
3144
gnutls.global_set_log_function(debug_gnutls)
2130
(gnutls.library.functions
2131
.gnutls_global_set_log_function(debug_gnutls))
3146
2133
# Redirect stdin so all checkers get /dev/null
3147
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2134
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3148
2135
os.dup2(null, sys.stdin.fileno())
2139
# No console logging
2140
logger.removeHandler(console)
3152
2142
# Need to fork before connecting to D-Bus
3154
2144
# Close all input and output, do double fork, etc.
3157
# multiprocessing will use threads, so before we use GLib we need
3158
# to inform GLib that threads will be used.
3161
2147
global main_loop
3162
2148
# From the Avahi example code
3163
DBusGMainLoop(set_as_default=True)
3164
main_loop = GLib.MainLoop()
2149
DBusGMainLoop(set_as_default=True )
2150
main_loop = gobject.MainLoop()
3165
2151
bus = dbus.SystemBus()
3166
2152
# End of Avahi example code
3169
2155
bus_name = dbus.service.BusName("se.recompile.Mandos",
3172
old_bus_name = dbus.service.BusName(
3173
"se.bsnet.fukt.Mandos", bus,
3175
except dbus.exceptions.DBusException as e:
3176
logger.error("Disabling D-Bus:", exc_info=e)
2156
bus, do_not_queue=True)
2157
old_bus_name = (dbus.service.BusName
2158
("se.bsnet.fukt.Mandos", bus,
2160
except dbus.exceptions.NameExistsException as e:
2161
logger.error(unicode(e) + ", disabling D-Bus")
3177
2162
use_dbus = False
3178
2163
server_settings["use_dbus"] = False
3179
2164
tcp_server.use_dbus = False
3181
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3182
service = AvahiServiceToSyslog(
3183
name=server_settings["servicename"],
3184
servicetype="_mandos._tcp",
3187
if server_settings["interface"]:
3188
service.interface = if_nametoindex(
3189
server_settings["interface"].encode("utf-8"))
2165
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2166
service = AvahiServiceToSyslog(name =
2167
server_settings["servicename"],
2168
servicetype = "_mandos._tcp",
2169
protocol = protocol, bus = bus)
2170
if server_settings["interface"]:
2171
service.interface = (if_nametoindex
2172
(str(server_settings["interface"])))
3191
2174
global multiprocessing_manager
3192
2175
multiprocessing_manager = multiprocessing.Manager()
3194
2177
client_class = Client
3196
client_class = functools.partial(ClientDBus, bus=bus)
3198
client_settings = Client.config_parser(client_config)
2179
client_class = functools.partial(ClientDBusTransitional,
2182
special_settings = {
2183
# Some settings need to be accessd by special methods;
2184
# booleans need .getboolean(), etc. Here is a list of them:
2185
"approved_by_default":
2187
client_config.getboolean(section, "approved_by_default"),
2190
client_config.getboolean(section, "enabled"),
2192
# Construct a new dict of client settings of this form:
2193
# { client_name: {setting_name: value, ...}, ...}
2194
# with exceptions for any special settings as defined above
2195
client_settings = dict((clientname,
2198
if setting not in special_settings
2199
else special_settings[setting]
2201
for setting, value in
2202
client_config.items(clientname)))
2203
for clientname in client_config.sections())
3199
2205
old_client_settings = {}
3202
# This is used to redirect stdout and stderr for checker processes
3204
wnull = open(os.devnull, "w") # A writable /dev/null
3205
# Only used if server is running in foreground but not in debug
3207
if debug or not foreground:
3210
2208
# Get client data and settings from last running state.
3211
2209
if server_settings["restore"]:
3213
2211
with open(stored_state_path, "rb") as stored_state:
3214
if sys.version_info.major == 2:
3215
clients_data, old_client_settings = pickle.load(
3218
bytes_clients_data, bytes_old_client_settings = (
3219
pickle.load(stored_state, encoding="bytes"))
3220
# Fix bytes to strings
3223
clients_data = {(key.decode("utf-8")
3224
if isinstance(key, bytes)
3227
bytes_clients_data.items()}
3228
del bytes_clients_data
3229
for key in clients_data:
3230
value = {(k.decode("utf-8")
3231
if isinstance(k, bytes) else k): v
3233
clients_data[key].items()}
3234
clients_data[key] = value
3236
value["client_structure"] = [
3238
if isinstance(s, bytes)
3240
value["client_structure"]]
3242
for k in ("name", "host"):
3243
if isinstance(value[k], bytes):
3244
value[k] = value[k].decode("utf-8")
3245
if not value.has_key("key_id"):
3246
value["key_id"] = ""
3247
elif not value.has_key("fingerprint"):
3248
value["fingerprint"] = ""
3249
# old_client_settings
3251
old_client_settings = {
3252
(key.decode("utf-8")
3253
if isinstance(key, bytes)
3256
bytes_old_client_settings.items()}
3257
del bytes_old_client_settings
3259
for value in old_client_settings.values():
3260
if isinstance(value["host"], bytes):
3261
value["host"] = (value["host"]
2212
clients_data, old_client_settings = (pickle.load
3263
2214
os.remove(stored_state_path)
3264
2215
except IOError as e:
3265
if e.errno == errno.ENOENT:
3266
logger.warning("Could not load persistent state:"
3267
" {}".format(os.strerror(e.errno)))
3269
logger.critical("Could not load persistent state:",
2216
logger.warning("Could not load persistent state: {0}"
2218
if e.errno != errno.ENOENT:
3272
except EOFError as e:
3273
logger.warning("Could not load persistent state: "
3277
with PGPEngine() as pgp:
3278
for client_name, client in clients_data.items():
3279
# Skip removed clients
3280
if client_name not in client_settings:
2221
with Crypto() as crypt:
2222
for client in clients_data:
2223
client_name = client["name"]
3283
2225
# Decide which value to use after restoring saved state.
3284
2226
# We have three different values: Old config file,
3285
2227
# new config file, and saved state.
3290
2232
# For each value in new config, check if it
3291
2233
# differs from the old config value (Except for
3292
2234
# the "secret" attribute)
3293
if (name != "secret"
3295
old_client_settings[client_name][name])):
3296
client[name] = value
2235
if (name != "secret" and
2236
value != old_client_settings[client_name]
2238
setattr(client, name, value)
3297
2239
except KeyError:
3300
2242
# Clients who has passed its expire date can still be
3301
# enabled if its last checker was successful. A Client
3302
# whose checker succeeded before we stored its state is
3303
# assumed to have successfully run all checkers during
3305
if client["enabled"]:
3306
if datetime.datetime.utcnow() >= client["expires"]:
3307
if not client["last_checked_ok"]:
3309
"disabling client {} - Client never "
3310
"performed a successful checker".format(
3312
client["enabled"] = False
3313
elif client["last_checker_status"] != 0:
3315
"disabling client {} - Client last"
3316
" checker failed with error code"
3319
client["last_checker_status"]))
2243
# enabled if its last checker was sucessful. Clients
2244
# whose checker failed before we stored its state is
2245
# assumed to have failed all checkers during downtime.
2246
if client["enabled"] and client["last_checked_ok"]:
2247
if ((datetime.datetime.utcnow()
2248
- client["last_checked_ok"])
2249
> client["interval"]):
2250
if client["last_checker_status"] != 0:
3320
2251
client["enabled"] = False
3322
client["expires"] = (
3323
datetime.datetime.utcnow()
3324
+ client["timeout"])
3325
logger.debug("Last checker succeeded,"
3326
" keeping {} enabled".format(
2253
client["expires"] = (datetime.datetime
2255
+ client["timeout"])
2257
client["changedstate"] = (multiprocessing_manager
2259
(multiprocessing_manager
2262
new_client = (ClientDBusTransitional.__new__
2263
(ClientDBusTransitional))
2264
tcp_server.clients[client_name] = new_client
2265
new_client.bus = bus
2266
for name, value in client.iteritems():
2267
setattr(new_client, name, value)
2268
client_object_name = unicode(client_name).translate(
2269
{ord("."): ord("_"),
2270
ord("-"): ord("_")})
2271
new_client.dbus_object_path = (dbus.ObjectPath
2273
+ client_object_name))
2274
DBusObjectWithProperties.__init__(new_client,
2279
tcp_server.clients[client_name] = (Client.__new__
2281
for name, value in client.iteritems():
2282
setattr(tcp_server.clients[client_name],
3329
client["secret"] = pgp.decrypt(
3330
client["encrypted_secret"],
2286
tcp_server.clients[client_name].secret = (
2287
crypt.decrypt(tcp_server.clients[client_name]
2289
client_settings[client_name]
2292
# If decryption fails, we use secret from new settings
2293
tcp_server.clients[client_name].secret = (
3331
2294
client_settings[client_name]["secret"])
3333
# If decryption fails, we use secret from new settings
3334
logger.debug("Failed to decrypt {} old secret".format(
3336
client["secret"] = (client_settings[client_name]
3339
# Add/remove clients based on new changes made to config
3340
for client_name in (set(old_client_settings)
3341
- set(client_settings)):
3342
del clients_data[client_name]
3343
for client_name in (set(client_settings)
3344
- set(old_client_settings)):
3345
clients_data[client_name] = client_settings[client_name]
3347
# Create all client objects
3348
for client_name, client in clients_data.items():
3349
tcp_server.clients[client_name] = client_class(
3352
server_settings=server_settings)
2296
# Create/remove clients based on new changes made to config
2297
for clientname in set(old_client_settings) - set(client_settings):
2298
del tcp_server.clients[clientname]
2299
for clientname in set(client_settings) - set(old_client_settings):
2300
tcp_server.clients[clientname] = (client_class(name
3354
2306
if not tcp_server.clients:
3355
2307
logger.warning("No clients defined")
3358
if pidfile is not None:
3362
print(pid, file=pidfile)
3364
logger.error("Could not write to file %r with PID %d",
2313
pidfile.write(str(pid) + "\n".encode("utf-8"))
2316
logger.error("Could not write to file %r with PID %d",
2319
# "pidfile" was never created
3367
2321
del pidfilename
3369
for termsig in (signal.SIGHUP, signal.SIGTERM):
3370
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3371
lambda: main_loop.quit() and False)
2323
signal.signal(signal.SIGINT, signal.SIG_IGN)
2325
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2326
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3375
@alternate_dbus_interfaces(
3376
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3377
class MandosDBusService(DBusObjectWithObjectManager):
2329
class MandosDBusService(dbus.service.Object):
3378
2330
"""A D-Bus proxy object"""
3380
2331
def __init__(self):
3381
2332
dbus.service.Object.__init__(self, bus, "/")
3383
2333
_interface = "se.recompile.Mandos"
3385
2335
@dbus.service.signal(_interface, signature="o")
3386
2336
def ClientAdded(self, objpath):
3390
2340
@dbus.service.signal(_interface, signature="ss")
3391
def ClientNotFound(self, key_id, address):
2341
def ClientNotFound(self, fingerprint, address):
3395
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3397
2345
@dbus.service.signal(_interface, signature="os")
3398
2346
def ClientRemoved(self, objpath, name):
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3404
2350
@dbus.service.method(_interface, out_signature="ao")
3405
2351
def GetAllClients(self):
3407
return dbus.Array(c.dbus_object_path for c in
3408
tcp_server.clients.values())
3410
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2353
return dbus.Array(c.dbus_object_path
2355
tcp_server.clients.itervalues())
3412
2357
@dbus.service.method(_interface,
3413
2358
out_signature="a{oa{sv}}")
3414
2359
def GetAllClientsWithProperties(self):
3416
2361
return dbus.Dictionary(
3417
{c.dbus_object_path: c.GetAll(
3418
"se.recompile.Mandos.Client")
3419
for c in tcp_server.clients.values()},
2362
((c.dbus_object_path, c.GetAll(""))
2363
for c in tcp_server.clients.itervalues()),
3420
2364
signature="oa{sv}")
3422
2366
@dbus.service.method(_interface, in_signature="o")
3423
2367
def RemoveClient(self, object_path):
3425
for c in tcp_server.clients.values():
2369
for c in tcp_server.clients.itervalues():
3426
2370
if c.dbus_object_path == object_path:
3427
2371
del tcp_server.clients[c.name]
3428
2372
c.remove_from_connection()
3429
# Don't signal the disabling
2373
# Don't signal anything except ClientRemoved
3430
2374
c.disable(quiet=True)
3431
# Emit D-Bus signal for removal
3432
self.client_removed_signal(c)
2376
self.ClientRemoved(object_path, c.name)
3434
2378
raise KeyError(object_path)
3438
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3439
out_signature="a{oa{sa{sv}}}")
3440
def GetManagedObjects(self):
3442
return dbus.Dictionary(
3443
{client.dbus_object_path:
3445
{interface: client.GetAll(interface)
3447
client._get_all_interface_names()})
3448
for client in tcp_server.clients.values()})
3450
def client_added_signal(self, client):
3451
"""Send the new standard signal and the old signal"""
3453
# New standard signal
3454
self.InterfacesAdded(
3455
client.dbus_object_path,
3457
{interface: client.GetAll(interface)
3459
client._get_all_interface_names()}))
3461
self.ClientAdded(client.dbus_object_path)
3463
def client_removed_signal(self, client):
3464
"""Send the new standard signal and the old signal"""
3466
# New standard signal
3467
self.InterfacesRemoved(
3468
client.dbus_object_path,
3469
client._get_all_interface_names())
3471
self.ClientRemoved(client.dbus_object_path,
3474
mandos_dbus_service = MandosDBusService()
3476
# Save modules to variables to exempt the modules from being
3477
# unloaded before the function registered with atexit() is run.
3478
mp = multiprocessing
2382
class MandosDBusServiceTransitional(MandosDBusService):
2383
__metaclass__ = AlternateDBusNamesMetaclass
2384
mandos_dbus_service = MandosDBusServiceTransitional()
3482
2387
"Cleanup function; run on exit"
3486
mp.active_children()
2390
multiprocessing.active_children()
3488
2391
if not (tcp_server.clients or client_settings):
3491
2394
# Store client before exiting. Secrets are encrypted with key
3492
2395
# based on what config file has. If config file is
3493
2396
# removed/edited, old secret will thus be unrecovable.
3495
with PGPEngine() as pgp:
3496
for client in tcp_server.clients.values():
2398
with Crypto() as crypt:
2399
for client in tcp_server.clients.itervalues():
3497
2400
key = client_settings[client.name]["secret"]
3498
client.encrypted_secret = pgp.encrypt(client.secret,
2401
client.encrypted_secret = crypt.encrypt(client.secret,
3500
2403
client_dict = {}
3502
# A list of attributes that can not be pickled
3504
exclude = {"bus", "changedstate", "secret",
3505
"checker", "server_settings"}
3506
for name, typ in inspect.getmembers(dbus.service
2405
# A list of attributes that will not be stored when
2407
exclude = set(("bus", "changedstate", "secret"))
2408
for name, typ in (inspect.getmembers
2409
(dbus.service.Object)):
3508
2410
exclude.add(name)
3510
2412
client_dict["encrypted_secret"] = (client
3511
2413
.encrypted_secret)
3512
2414
for attr in client.client_structure:
3513
2415
if attr not in exclude:
3514
2416
client_dict[attr] = getattr(client, attr)
3516
clients[client.name] = client_dict
2418
clients.append(client_dict)
3517
2419
del client_settings[client.name]["secret"]
3520
with tempfile.NamedTemporaryFile(
3524
dir=os.path.dirname(stored_state_path),
3525
delete=False) as stored_state:
3526
pickle.dump((clients, client_settings), stored_state,
3528
tempname = stored_state.name
3529
os.rename(tempname, stored_state_path)
2422
with os.fdopen(os.open(stored_state_path,
2423
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2424
0600), "wb") as stored_state:
2425
pickle.dump((clients, client_settings), stored_state)
3530
2426
except (IOError, OSError) as e:
3536
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3537
logger.warning("Could not save persistent state: {}"
3538
.format(os.strerror(e.errno)))
3540
logger.warning("Could not save persistent state:",
2427
logger.warning("Could not save persistent state: {0}"
2429
if e.errno not in (errno.ENOENT, errno.EACCES):
3544
2432
# Delete all clients, and settings from config
3545
2433
while tcp_server.clients:
3546
2434
name, client = tcp_server.clients.popitem()
3548
2436
client.remove_from_connection()
3549
# Don't signal the disabling
2437
# Don't signal anything except ClientRemoved
3550
2438
client.disable(quiet=True)
3551
# Emit D-Bus signal for removal
3553
mandos_dbus_service.client_removed_signal(client)
2441
mandos_dbus_service.ClientRemoved(client
3554
2444
client_settings.clear()
3556
2446
atexit.register(cleanup)
3558
for client in tcp_server.clients.values():
2448
for client in tcp_server.clients.itervalues():
3560
# Emit D-Bus signal for adding
3561
mandos_dbus_service.client_added_signal(client)
2451
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3562
2452
# Need to initiate checking of clients
3563
2453
if client.enabled:
3564
2454
client.init_checker()
3566
2456
tcp_server.enable()
3567
2457
tcp_server.server_activate()
3569
2459
# Find out what port we got
3571
service.port = tcp_server.socket.getsockname()[1]
2460
service.port = tcp_server.socket.getsockname()[1]
3573
2462
logger.info("Now listening on address %r, port %d,"
3574
" flowinfo %d, scope_id %d",
3575
*tcp_server.socket.getsockname())
2463
" flowinfo %d, scope_id %d"
2464
% tcp_server.socket.getsockname())
3577
logger.info("Now listening on address %r, port %d",
3578
*tcp_server.socket.getsockname())
3580
# service.interface = tcp_server.socket.getsockname()[3]
2466
logger.info("Now listening on address %r, port %d"
2467
% tcp_server.socket.getsockname())
2469
#service.interface = tcp_server.socket.getsockname()[3]
3584
# From the Avahi example code
3587
except dbus.exceptions.DBusException as error:
3588
logger.critical("D-Bus Exception", exc_info=error)
3591
# End of Avahi example code
3593
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3594
lambda *args, **kwargs:
3595
(tcp_server.handle_request
3596
(*args[2:], **kwargs) or True))
2472
# From the Avahi example code
2475
except dbus.exceptions.DBusException as error:
2476
logger.critical("DBusException: %s", error)
2479
# End of Avahi example code
2481
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2482
lambda *args, **kwargs:
2483
(tcp_server.handle_request
2484
(*args[2:], **kwargs) or True))
3598
2486
logger.debug("Starting main loop")
3599
2487
main_loop.run()
3600
2488
except AvahiError as error:
3601
logger.critical("Avahi Error", exc_info=error)
2489
logger.critical("AvahiError: %s", error)
3604
2492
except KeyboardInterrupt: