To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 350
- compare with another revision
- download diff
- download tarball
- view history from revision 350
- Committer: Teddy Hogeborn
- Date: 2016-10-01 13:56:09 UTC
- mfrom: (237.7.423 trunk)
- Revision ID: teddy@recompile.se-20161001135609-y5q39hvf2d95utwf
Merge from trunk
added
removed
mandos
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
#
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
#
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
#
12
#
13
13
# Everything else is
14
14
# Copyright © 2008-2016 Teddy Hogeborn
15
15
# Copyright © 2008-2016 Björn Påhlsson
16
#
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
19
19
# the Free Software Foundation, either version 3 of the License, or
23
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
25
# GNU General Public License for more details.
26
#
26
#
27
27
# You should have received a copy of the GNU General Public License
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
#
30
#
31
31
# Contact the authors at <mandos@recompile.se>.
32
#
32
#
33
33
34
34
from __future__ import (division, absolute_import, print_function,
35
35
unicode_literals)
124
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
125
ctypes.util.find_library("c")).if_nametoindex
126
126
except (OSError, AttributeError):
127
127
128
128
def if_nametoindex(interface):
129
129
"Get an interface index the hard way, i.e. using fcntl()"
130
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
153
153
154
154
def initlogger(debug, level=logging.WARNING):
155
155
"""init logger and add loglevel"""
156
156
157
157
global syslogger
158
158
syslogger = (logging.handlers.SysLogHandler(
159
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
160
address = "/dev/log"))
159
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
160
address="/dev/log"))
161
161
syslogger.setFormatter(logging.Formatter
162
162
('Mandos [%(process)d]: %(levelname)s:'
163
163
' %(message)s'))
164
164
logger.addHandler(syslogger)
165
165
166
166
if debug:
167
167
console = logging.StreamHandler()
168
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
180
180
181
181
class PGPEngine(object):
182
182
"""A simple class for OpenPGP symmetric encryption & decryption"""
183
183
184
184
def __init__(self):
185
185
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
186
186
self.gpg = "gpg"
201
201
# Only GPG version 1 has the --no-use-agent option.
202
202
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
203
203
self.gnupgargs.append("--no-use-agent")
204
204
205
205
def __enter__(self):
206
206
return self
207
207
208
208
def __exit__(self, exc_type, exc_value, traceback):
209
209
self._cleanup()
210
210
return False
211
211
212
212
def __del__(self):
213
213
self._cleanup()
214
214
215
215
def _cleanup(self):
216
216
if self.tempdir is not None:
217
217
# Delete contents of tempdir
218
218
for root, dirs, files in os.walk(self.tempdir,
219
topdown = False):
219
topdown=False):
220
220
for filename in files:
221
221
os.remove(os.path.join(root, filename))
222
222
for dirname in dirs:
224
224
# Remove tempdir
225
225
os.rmdir(self.tempdir)
226
226
self.tempdir = None
227
227
228
228
def password_encode(self, password):
229
229
# Passphrase can not be empty and can not contain newlines or
230
230
# NUL bytes. So we prefix it and hex encode it.
235
235
.replace(b"\n", b"\\n")
236
236
.replace(b"\0", b"\\x00"))
237
237
return encoded
238
238
239
239
def encrypt(self, data, password):
240
240
passphrase = self.password_encode(password)
241
241
with tempfile.NamedTemporaryFile(
246
246
'--passphrase-file',
247
247
passfile.name]
248
248
+ self.gnupgargs,
249
stdin = subprocess.PIPE,
250
stdout = subprocess.PIPE,
251
stderr = subprocess.PIPE)
252
ciphertext, err = proc.communicate(input = data)
249
stdin=subprocess.PIPE,
250
stdout=subprocess.PIPE,
251
stderr=subprocess.PIPE)
252
ciphertext, err = proc.communicate(input=data)
253
253
if proc.returncode != 0:
254
254
raise PGPError(err)
255
255
return ciphertext
256
256
257
257
def decrypt(self, data, password):
258
258
passphrase = self.password_encode(password)
259
259
with tempfile.NamedTemporaryFile(
260
dir = self.tempdir) as passfile:
260
dir=self.tempdir) as passfile:
261
261
passfile.write(passphrase)
262
262
passfile.flush()
263
263
proc = subprocess.Popen([self.gpg, '--decrypt',
264
264
'--passphrase-file',
265
265
passfile.name]
266
266
+ self.gnupgargs,
267
stdin = subprocess.PIPE,
268
stdout = subprocess.PIPE,
269
stderr = subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input = data)
267
stdin=subprocess.PIPE,
268
stdout=subprocess.PIPE,
269
stderr=subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input=data)
271
271
if proc.returncode != 0:
272
272
raise PGPError(err)
273
273
return decrypted_plaintext
274
274
275
275
276
# Pretend that we have an Avahi module
276
277
class Avahi(object):
277
278
"""This isn't so much a class as it is a module-like namespace.
278
279
It is instantiated once, and simulates having an Avahi module."""
279
IF_UNSPEC = -1 # avahi-common/address.h
280
PROTO_UNSPEC = -1 # avahi-common/address.h
281
PROTO_INET = 0 # avahi-common/address.h
282
PROTO_INET6 = 1 # avahi-common/address.h
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
283
284
DBUS_NAME = "org.freedesktop.Avahi"
284
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
285
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
286
287
DBUS_PATH_SERVER = "/"
288
287
289
def string_array_to_txt_array(self, t):
288
290
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
289
291
for s in t), signature="ay")
290
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
291
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
292
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
293
SERVER_INVALID = 0 # avahi-common/defs.h
294
SERVER_REGISTERING = 1 # avahi-common/defs.h
295
SERVER_RUNNING = 2 # avahi-common/defs.h
296
SERVER_COLLISION = 3 # avahi-common/defs.h
297
SERVER_FAILURE = 4 # avahi-common/defs.h
292
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
293
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
294
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
295
SERVER_INVALID = 0 # avahi-common/defs.h
296
SERVER_REGISTERING = 1 # avahi-common/defs.h
297
SERVER_RUNNING = 2 # avahi-common/defs.h
298
SERVER_COLLISION = 3 # avahi-common/defs.h
299
SERVER_FAILURE = 4 # avahi-common/defs.h
298
300
avahi = Avahi()
299
301
302
300
303
class AvahiError(Exception):
301
304
def __init__(self, value, *args, **kwargs):
302
305
self.value = value
314
317
315
318
class AvahiService(object):
316
319
"""An Avahi (Zeroconf) service.
317
320
318
321
Attributes:
319
322
interface: integer; avahi.IF_UNSPEC or an interface index.
320
323
Used to optionally bind to the specified interface.
332
335
server: D-Bus Server
333
336
bus: dbus.SystemBus()
334
337
"""
335
338
336
339
def __init__(self,
337
interface = avahi.IF_UNSPEC,
338
name = None,
339
servicetype = None,
340
port = None,
341
TXT = None,
342
domain = "",
343
host = "",
344
max_renames = 32768,
345
protocol = avahi.PROTO_UNSPEC,
346
bus = None):
340
interface=avahi.IF_UNSPEC,
341
name=None,
342
servicetype=None,
343
port=None,
344
TXT=None,
345
domain="",
346
host="",
347
max_renames=32768,
348
protocol=avahi.PROTO_UNSPEC,
349
bus=None):
347
350
self.interface = interface
348
351
self.name = name
349
352
self.type = servicetype
358
361
self.server = None
359
362
self.bus = bus
360
363
self.entry_group_state_changed_match = None
361
364
362
365
def rename(self, remove=True):
363
366
"""Derived from the Avahi example code"""
364
367
if self.rename_count >= self.max_renames:
384
387
logger.critical("D-Bus Exception", exc_info=error)
385
388
self.cleanup()
386
389
os._exit(1)
387
390
388
391
def remove(self):
389
392
"""Derived from the Avahi example code"""
390
393
if self.entry_group_state_changed_match is not None:
392
395
self.entry_group_state_changed_match = None
393
396
if self.group is not None:
394
397
self.group.Reset()
395
398
396
399
def add(self):
397
400
"""Derived from the Avahi example code"""
398
401
self.remove()
415
418
dbus.UInt16(self.port),
416
419
avahi.string_array_to_txt_array(self.TXT))
417
420
self.group.Commit()
418
421
419
422
def entry_group_state_changed(self, state, error):
420
423
"""Derived from the Avahi example code"""
421
424
logger.debug("Avahi entry group state change: %i", state)
422
425
423
426
if state == avahi.ENTRY_GROUP_ESTABLISHED:
424
427
logger.debug("Zeroconf service established.")
425
428
elif state == avahi.ENTRY_GROUP_COLLISION:
429
432
logger.critical("Avahi: Error in group state changed %s",
430
433
str(error))
431
434
raise AvahiGroupError("State changed: {!s}".format(error))
432
435
433
436
def cleanup(self):
434
437
"""Derived from the Avahi example code"""
435
438
if self.group is not None:
440
443
pass
441
444
self.group = None
442
445
self.remove()
443
446
444
447
def server_state_changed(self, state, error=None):
445
448
"""Derived from the Avahi example code"""
446
449
logger.debug("Avahi server state change: %i", state)
475
478
logger.debug("Unknown state: %r", state)
476
479
else:
477
480
logger.debug("Unknown state: %r: %r", state, error)
478
481
479
482
def activate(self):
480
483
"""Derived from the Avahi example code"""
481
484
if self.server is None:
498
501
.format(self.name)))
499
502
return ret
500
503
504
501
505
# Pretend that we have a GnuTLS module
502
506
class GnuTLS(object):
503
507
"""This isn't so much a class as it is a module-like namespace.
504
508
It is instantiated once, and simulates having a GnuTLS module."""
505
506
_library = ctypes.cdll.LoadLibrary(
507
ctypes.util.find_library("gnutls"))
509
510
library = ctypes.util.find_library("gnutls")
511
if library is None:
512
library = ctypes.util.find_library("gnutls-deb0")
513
_library = ctypes.cdll.LoadLibrary(library)
514
del library
508
515
_need_version = b"3.3.0"
516
509
517
def __init__(self):
510
518
# Need to use class name "GnuTLS" here, since this method is
511
519
# called before the assignment to the "gnutls" global variable
513
521
if GnuTLS.check_version(self._need_version) is None:
514
522
raise GnuTLS.Error("Needs GnuTLS {} or later"
515
523
.format(self._need_version))
516
524
517
525
# Unless otherwise indicated, the constants and types below are
518
526
# all from the gnutls/gnutls.h C header file.
519
527
520
528
# Constants
521
529
E_SUCCESS = 0
522
530
E_INTERRUPTED = -52
527
535
CRD_CERTIFICATE = 1
528
536
E_NO_CERTIFICATE_FOUND = -49
529
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
530
538
531
539
# Types
532
540
class session_int(ctypes.Structure):
533
541
_fields_ = []
534
542
session_t = ctypes.POINTER(session_int)
543
535
544
class certificate_credentials_st(ctypes.Structure):
536
545
_fields_ = []
537
546
certificate_credentials_t = ctypes.POINTER(
538
547
certificate_credentials_st)
539
548
certificate_type_t = ctypes.c_int
549
540
550
class datum_t(ctypes.Structure):
541
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
542
552
('size', ctypes.c_uint)]
553
543
554
class openpgp_crt_int(ctypes.Structure):
544
555
_fields_ = []
545
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
546
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
547
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
548
559
credentials_type_t = ctypes.c_int
549
560
transport_ptr_t = ctypes.c_void_p
550
561
close_request_t = ctypes.c_int
551
562
552
563
# Exceptions
553
564
class Error(Exception):
554
565
# We need to use the class name "GnuTLS" here, since this
555
566
# exception might be raised from within GnuTLS.__init__,
556
567
# which is called before the assignment to the "gnutls"
557
568
# global variable has happened.
558
def __init__(self, message = None, code = None, args=()):
569
def __init__(self, message=None, code=None, args=()):
559
570
# Default usage is by a message string, but if a return
560
571
# code is passed, convert it to a string with
561
572
# gnutls.strerror()
564
575
message = GnuTLS.strerror(code)
565
576
return super(GnuTLS.Error, self).__init__(
566
577
message, *args)
567
578
568
579
class CertificateSecurityError(Error):
569
580
pass
570
581
571
582
# Classes
572
583
class Credentials(object):
573
584
def __init__(self):
575
586
gnutls.certificate_allocate_credentials(
576
587
ctypes.byref(self._c_object))
577
588
self.type = gnutls.CRD_CERTIFICATE
578
589
579
590
def __del__(self):
580
591
gnutls.certificate_free_credentials(self._c_object)
581
592
582
593
class ClientSession(object):
583
def __init__(self, socket, credentials = None):
594
def __init__(self, socket, credentials=None):
584
595
self._c_object = gnutls.session_t()
585
596
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
586
597
gnutls.set_default_priority(self._c_object)
594
605
ctypes.cast(credentials._c_object,
595
606
ctypes.c_void_p))
596
607
self.credentials = credentials
597
608
598
609
def __del__(self):
599
610
gnutls.deinit(self._c_object)
600
611
601
612
def handshake(self):
602
613
return gnutls.handshake(self._c_object)
603
614
604
615
def send(self, data):
605
616
data = bytes(data)
606
617
data_len = len(data)
608
619
data_len -= gnutls.record_send(self._c_object,
609
620
data[-data_len:],
610
621
data_len)
611
622
612
623
def bye(self):
613
624
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
614
625
615
626
# Error handling functions
616
627
def _error_code(result):
617
628
"""A function to raise exceptions on errors, suitable
619
630
if result >= 0:
620
631
return result
621
632
if result == gnutls.E_NO_CERTIFICATE_FOUND:
622
raise gnutls.CertificateSecurityError(code = result)
623
raise gnutls.Error(code = result)
624
633
raise gnutls.CertificateSecurityError(code=result)
634
raise gnutls.Error(code=result)
635
625
636
def _retry_on_error(result, func, arguments):
626
637
"""A function to retry on some errors, suitable
627
638
for the 'errcheck' attribute on ctypes functions"""
630
641
return _error_code(result)
631
642
result = func(*arguments)
632
643
return result
633
644
634
645
# Unless otherwise indicated, the function declarations below are
635
646
# all from the gnutls/gnutls.h C header file.
636
647
637
648
# Functions
638
649
priority_set_direct = _library.gnutls_priority_set_direct
639
650
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
640
651
ctypes.POINTER(ctypes.c_char_p)]
641
652
priority_set_direct.restype = _error_code
642
653
643
654
init = _library.gnutls_init
644
655
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
645
656
init.restype = _error_code
646
657
647
658
set_default_priority = _library.gnutls_set_default_priority
648
659
set_default_priority.argtypes = [session_t]
649
660
set_default_priority.restype = _error_code
650
661
651
662
record_send = _library.gnutls_record_send
652
663
record_send.argtypes = [session_t, ctypes.c_void_p,
653
664
ctypes.c_size_t]
654
665
record_send.restype = ctypes.c_ssize_t
655
666
record_send.errcheck = _retry_on_error
656
667
657
668
certificate_allocate_credentials = (
658
669
_library.gnutls_certificate_allocate_credentials)
659
670
certificate_allocate_credentials.argtypes = [
660
671
ctypes.POINTER(certificate_credentials_t)]
661
672
certificate_allocate_credentials.restype = _error_code
662
673
663
674
certificate_free_credentials = (
664
675
_library.gnutls_certificate_free_credentials)
665
certificate_free_credentials.argtypes = [certificate_credentials_t]
676
certificate_free_credentials.argtypes = [
677
certificate_credentials_t]
666
678
certificate_free_credentials.restype = None
667
679
668
680
handshake_set_private_extensions = (
669
681
_library.gnutls_handshake_set_private_extensions)
670
682
handshake_set_private_extensions.argtypes = [session_t,
671
683
ctypes.c_int]
672
684
handshake_set_private_extensions.restype = None
673
685
674
686
credentials_set = _library.gnutls_credentials_set
675
687
credentials_set.argtypes = [session_t, credentials_type_t,
676
688
ctypes.c_void_p]
677
689
credentials_set.restype = _error_code
678
690
679
691
strerror = _library.gnutls_strerror
680
692
strerror.argtypes = [ctypes.c_int]
681
693
strerror.restype = ctypes.c_char_p
682
694
683
695
certificate_type_get = _library.gnutls_certificate_type_get
684
696
certificate_type_get.argtypes = [session_t]
685
697
certificate_type_get.restype = _error_code
686
698
687
699
certificate_get_peers = _library.gnutls_certificate_get_peers
688
700
certificate_get_peers.argtypes = [session_t,
689
701
ctypes.POINTER(ctypes.c_uint)]
690
702
certificate_get_peers.restype = ctypes.POINTER(datum_t)
691
703
692
704
global_set_log_level = _library.gnutls_global_set_log_level
693
705
global_set_log_level.argtypes = [ctypes.c_int]
694
706
global_set_log_level.restype = None
695
707
696
708
global_set_log_function = _library.gnutls_global_set_log_function
697
709
global_set_log_function.argtypes = [log_func]
698
710
global_set_log_function.restype = None
699
711
700
712
deinit = _library.gnutls_deinit
701
713
deinit.argtypes = [session_t]
702
714
deinit.restype = None
703
715
704
716
handshake = _library.gnutls_handshake
705
717
handshake.argtypes = [session_t]
706
718
handshake.restype = _error_code
707
719
handshake.errcheck = _retry_on_error
708
720
709
721
transport_set_ptr = _library.gnutls_transport_set_ptr
710
722
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
711
723
transport_set_ptr.restype = None
712
724
713
725
bye = _library.gnutls_bye
714
726
bye.argtypes = [session_t, close_request_t]
715
727
bye.restype = _error_code
716
728
bye.errcheck = _retry_on_error
717
729
718
730
check_version = _library.gnutls_check_version
719
731
check_version.argtypes = [ctypes.c_char_p]
720
732
check_version.restype = ctypes.c_char_p
721
733
722
734
# All the function declarations below are from gnutls/openpgp.h
723
735
724
736
openpgp_crt_init = _library.gnutls_openpgp_crt_init
725
737
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
726
738
openpgp_crt_init.restype = _error_code
727
739
728
740
openpgp_crt_import = _library.gnutls_openpgp_crt_import
729
741
openpgp_crt_import.argtypes = [openpgp_crt_t,
730
742
ctypes.POINTER(datum_t),
731
743
openpgp_crt_fmt_t]
732
744
openpgp_crt_import.restype = _error_code
733
745
734
746
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
735
747
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
736
748
ctypes.POINTER(ctypes.c_uint)]
737
749
openpgp_crt_verify_self.restype = _error_code
738
750
739
751
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
740
752
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
741
753
openpgp_crt_deinit.restype = None
742
754
743
755
openpgp_crt_get_fingerprint = (
744
756
_library.gnutls_openpgp_crt_get_fingerprint)
745
757
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
747
759
ctypes.POINTER(
748
760
ctypes.c_size_t)]
749
761
openpgp_crt_get_fingerprint.restype = _error_code
750
762
751
763
# Remove non-public functions
752
764
del _error_code, _retry_on_error
753
765
# Create the global "gnutls" object, simulating a module
754
766
gnutls = GnuTLS()
755
767
768
756
769
def call_pipe(connection, # : multiprocessing.Connection
757
770
func, *args, **kwargs):
758
771
"""This function is meant to be called by multiprocessing.Process
759
772
760
773
This function runs func(*args, **kwargs), and writes the resulting
761
774
return value on the provided multiprocessing.Connection.
762
775
"""
763
776
connection.send(func(*args, **kwargs))
764
777
connection.close()
765
778
779
766
780
class Client(object):
767
781
"""A representation of a client host served by this server.
768
782
769
783
Attributes:
770
784
approved: bool(); 'None' if not yet approved/disapproved
771
785
approval_delay: datetime.timedelta(); Time to wait for approval
808
822
disabled, or None
809
823
server_settings: The server_settings dict from main()
810
824
"""
811
825
812
826
runtime_expansions = ("approval_delay", "approval_duration",
813
827
"created", "enabled", "expires",
814
828
"fingerprint", "host", "interval",
825
839
"approved_by_default": "True",
826
840
"enabled": "True",
827
841
}
828
842
829
843
@staticmethod
830
844
def config_parser(config):
831
845
"""Construct a new dict of client settings of this form:
838
852
for client_name in config.sections():
839
853
section = dict(config.items(client_name))
840
854
client = settings[client_name] = {}
841
855
842
856
client["host"] = section["host"]
843
857
# Reformat values from string types to Python types
844
858
client["approved_by_default"] = config.getboolean(
845
859
client_name, "approved_by_default")
846
860
client["enabled"] = config.getboolean(client_name,
847
861
"enabled")
848
862
849
863
# Uppercase and remove spaces from fingerprint for later
850
864
# comparison purposes with return value from the
851
865
# fingerprint() function
875
889
client["last_approval_request"] = None
876
890
client["last_checked_ok"] = None
877
891
client["last_checker_status"] = -2
878
892
879
893
return settings
880
881
def __init__(self, settings, name = None, server_settings=None):
894
895
def __init__(self, settings, name=None, server_settings=None):
882
896
self.name = name
883
897
if server_settings is None:
884
898
server_settings = {}
886
900
# adding all client settings
887
901
for setting, value in settings.items():
888
902
setattr(self, setting, value)
889
903
890
904
if self.enabled:
891
905
if not hasattr(self, "last_enabled"):
892
906
self.last_enabled = datetime.datetime.utcnow()
896
910
else:
897
911
self.last_enabled = None
898
912
self.expires = None
899
913
900
914
logger.debug("Creating client %r", self.name)
901
915
logger.debug(" Fingerprint: %s", self.fingerprint)
902
916
self.created = settings.get("created",
903
917
datetime.datetime.utcnow())
904
918
905
919
# attributes specific for this server instance
906
920
self.checker = None
907
921
self.checker_initiator_tag = None
916
930
for attr in self.__dict__.keys()
917
931
if not attr.startswith("_")]
918
932
self.client_structure.append("client_structure")
919
933
920
934
for name, t in inspect.getmembers(
921
935
type(self), lambda obj: isinstance(obj, property)):
922
936
if not name.startswith("_"):
923
937
self.client_structure.append(name)
924
938
925
939
# Send notice to process children that client state has changed
926
940
def send_changedstate(self):
927
941
with self.changedstate:
928
942
self.changedstate.notify_all()
929
943
930
944
def enable(self):
931
945
"""Start this client's checker and timeout hooks"""
932
946
if getattr(self, "enabled", False):
937
951
self.last_enabled = datetime.datetime.utcnow()
938
952
self.init_checker()
939
953
self.send_changedstate()
940
954
941
955
def disable(self, quiet=True):
942
956
"""Disable this client."""
943
957
if not getattr(self, "enabled", False):
957
971
self.send_changedstate()
958
972
# Do not run this again if called by a GLib.timeout_add
959
973
return False
960
974
961
975
def __del__(self):
962
976
self.disable()
963
977
964
978
def init_checker(self):
965
979
# Schedule a new checker to be started an 'interval' from now,
966
980
# and every interval from then on.
976
990
int(self.timeout.total_seconds() * 1000), self.disable)
977
991
# Also start a new checker *right now*.
978
992
self.start_checker()
979
993
980
994
def checker_callback(self, source, condition, connection,
981
995
command):
982
996
"""The checker has completed, so take appropriate actions."""
985
999
# Read return code from connection (see call_pipe)
986
1000
returncode = connection.recv()
987
1001
connection.close()
988
1002
989
1003
if returncode >= 0:
990
1004
self.last_checker_status = returncode
991
1005
self.last_checker_signal = None
1001
1015
logger.warning("Checker for %(name)s crashed?",
1002
1016
vars(self))
1003
1017
return False
1004
1018
1005
1019
def checked_ok(self):
1006
1020
"""Assert that the client has been seen, alive and well."""
1007
1021
self.last_checked_ok = datetime.datetime.utcnow()
1008
1022
self.last_checker_status = 0
1009
1023
self.last_checker_signal = None
1010
1024
self.bump_timeout()
1011
1025
1012
1026
def bump_timeout(self, timeout=None):
1013
1027
"""Bump up the timeout for this client."""
1014
1028
if timeout is None:
1020
1034
self.disable_initiator_tag = GLib.timeout_add(
1021
1035
int(timeout.total_seconds() * 1000), self.disable)
1022
1036
self.expires = datetime.datetime.utcnow() + timeout
1023
1037
1024
1038
def need_approval(self):
1025
1039
self.last_approval_request = datetime.datetime.utcnow()
1026
1040
1027
1041
def start_checker(self):
1028
1042
"""Start a new checker subprocess if one is not running.
1029
1043
1030
1044
If a checker already exists, leave it running and do
1031
1045
nothing."""
1032
1046
# The reason for not killing a running checker is that if we
1037
1051
# checkers alone, the checker would have to take more time
1038
1052
# than 'timeout' for the client to be disabled, which is as it
1039
1053
# should be.
1040
1054
1041
1055
if self.checker is not None and not self.checker.is_alive():
1042
1056
logger.warning("Checker was not alive; joining")
1043
1057
self.checker.join()
1047
1061
# Escape attributes for the shell
1048
1062
escaped_attrs = {
1049
1063
attr: re.escape(str(getattr(self, attr)))
1050
for attr in self.runtime_expansions }
1064
for attr in self.runtime_expansions}
1051
1065
try:
1052
1066
command = self.checker_command % escaped_attrs
1053
1067
except TypeError as error:
1065
1079
# The exception is when not debugging but nevertheless
1066
1080
# running in the foreground; use the previously
1067
1081
# created wnull.
1068
popen_args = { "close_fds": True,
1069
"shell": True,
1070
"cwd": "/" }
1082
popen_args = {"close_fds": True,
1083
"shell": True,
1084
"cwd": "/"}
1071
1085
if (not self.server_settings["debug"]
1072
1086
and self.server_settings["foreground"]):
1073
1087
popen_args.update({"stdout": wnull,
1074
"stderr": wnull })
1075
pipe = multiprocessing.Pipe(duplex = False)
1088
"stderr": wnull})
1089
pipe = multiprocessing.Pipe(duplex=False)
1076
1090
self.checker = multiprocessing.Process(
1077
target = call_pipe,
1078
args = (pipe[1], subprocess.call, command),
1079
kwargs = popen_args)
1091
target=call_pipe,
1092
args=(pipe[1], subprocess.call, command),
1093
kwargs=popen_args)
1080
1094
self.checker.start()
1081
1095
self.checker_callback_tag = GLib.io_add_watch(
1082
1096
pipe[0].fileno(), GLib.IO_IN,
1083
1097
self.checker_callback, pipe[0], command)
1084
1098
# Re-run this periodically if run by GLib.timeout_add
1085
1099
return True
1086
1100
1087
1101
def stop_checker(self):
1088
1102
"""Force the checker process, if any, to stop."""
1089
1103
if self.checker_callback_tag:
1102
1116
byte_arrays=False):
1103
1117
"""Decorators for marking methods of a DBusObjectWithProperties to
1104
1118
become properties on the D-Bus.
1105
1119
1106
1120
The decorated method will be called with no arguments by "Get"
1107
1121
and with one argument by "Set".
1108
1122
1109
1123
The parameters, where they are supported, are the same as
1110
1124
dbus.service.method, except there is only "signature", since the
1111
1125
type from Get() and the type sent to Set() is the same.
1115
1129
if byte_arrays and signature != "ay":
1116
1130
raise ValueError("Byte arrays not supported for non-'ay'"
1117
1131
" signature {!r}".format(signature))
1118
1132
1119
1133
def decorator(func):
1120
1134
func._dbus_is_property = True
1121
1135
func._dbus_interface = dbus_interface
1124
1138
func._dbus_name = func.__name__
1125
1139
if func._dbus_name.endswith("_dbus_property"):
1126
1140
func._dbus_name = func._dbus_name[:-14]
1127
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1141
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1128
1142
return func
1129
1143
1130
1144
return decorator
1131
1145
1132
1146
1133
1147
def dbus_interface_annotations(dbus_interface):
1134
1148
"""Decorator for marking functions returning interface annotations
1135
1149
1136
1150
Usage:
1137
1151
1138
1152
@dbus_interface_annotations("org.example.Interface")
1139
1153
def _foo(self): # Function name does not matter
1140
1154
return {"org.freedesktop.DBus.Deprecated": "true",
1141
1155
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1142
1156
"false"}
1143
1157
"""
1144
1158
1145
1159
def decorator(func):
1146
1160
func._dbus_is_interface = True
1147
1161
func._dbus_interface = dbus_interface
1148
1162
func._dbus_name = dbus_interface
1149
1163
return func
1150
1164
1151
1165
return decorator
1152
1166
1153
1167
1154
1168
def dbus_annotations(annotations):
1155
1169
"""Decorator to annotate D-Bus methods, signals or properties
1156
1170
Usage:
1157
1171
1158
1172
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1159
1173
"org.freedesktop.DBus.Property."
1160
1174
"EmitsChangedSignal": "false"})
1162
1176
access="r")
1163
1177
def Property_dbus_property(self):
1164
1178
return dbus.Boolean(False)
1165
1179
1166
1180
See also the DBusObjectWithAnnotations class.
1167
1181
"""
1168
1182
1169
1183
def decorator(func):
1170
1184
func._dbus_annotations = annotations
1171
1185
return func
1172
1186
1173
1187
return decorator
1174
1188
1175
1189
1193
1207
1194
1208
class DBusObjectWithAnnotations(dbus.service.Object):
1195
1209
"""A D-Bus object with annotations.
1196
1210
1197
1211
Classes inheriting from this can use the dbus_annotations
1198
1212
decorator to add annotations to methods or signals.
1199
1213
"""
1200
1214
1201
1215
@staticmethod
1202
1216
def _is_dbus_thing(thing):
1203
1217
"""Returns a function testing if an attribute is a D-Bus thing
1204
1218
1205
1219
If called like _is_dbus_thing("method") it returns a function
1206
1220
suitable for use as predicate to inspect.getmembers().
1207
1221
"""
1208
1222
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1209
1223
False)
1210
1224
1211
1225
def _get_all_dbus_things(self, thing):
1212
1226
"""Returns a generator of (name, attribute) pairs
1213
1227
"""
1216
1230
for cls in self.__class__.__mro__
1217
1231
for name, athing in
1218
1232
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1219
1233
1220
1234
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1221
out_signature = "s",
1222
path_keyword = 'object_path',
1223
connection_keyword = 'connection')
1235
out_signature="s",
1236
path_keyword='object_path',
1237
connection_keyword='connection')
1224
1238
def Introspect(self, object_path, connection):
1225
1239
"""Overloading of standard D-Bus method.
1226
1240
1227
1241
Inserts annotation tags on methods and signals.
1228
1242
"""
1229
1243
xmlstring = dbus.service.Object.Introspect(self, object_path,
1230
1244
connection)
1231
1245
try:
1232
1246
document = xml.dom.minidom.parseString(xmlstring)
1233
1247
1234
1248
for if_tag in document.getElementsByTagName("interface"):
1235
1249
# Add annotation tags
1236
1250
for typ in ("method", "signal"):
1263
1277
if_tag.appendChild(ann_tag)
1264
1278
# Fix argument name for the Introspect method itself
1265
1279
if (if_tag.getAttribute("name")
1266
== dbus.INTROSPECTABLE_IFACE):
1280
== dbus.INTROSPECTABLE_IFACE):
1267
1281
for cn in if_tag.getElementsByTagName("method"):
1268
1282
if cn.getAttribute("name") == "Introspect":
1269
1283
for arg in cn.getElementsByTagName("arg"):
1282
1296
1283
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1284
1298
"""A D-Bus object with properties.
1285
1299
1286
1300
Classes inheriting from this can use the dbus_service_property
1287
1301
decorator to expose methods as D-Bus properties. It exposes the
1288
1302
standard Get(), Set(), and GetAll() methods on the D-Bus.
1289
1303
"""
1290
1304
1291
1305
def _get_dbus_property(self, interface_name, property_name):
1292
1306
"""Returns a bound method if one exists which is a D-Bus
1293
1307
property with the specified name and interface.
1298
1312
if (value._dbus_name == property_name
1299
1313
and value._dbus_interface == interface_name):
1300
1314
return value.__get__(self)
1301
1315
1302
1316
# No such property
1303
1317
raise DBusPropertyNotFound("{}:{}.{}".format(
1304
1318
self.dbus_object_path, interface_name, property_name))
1305
1319
1306
1320
@classmethod
1307
1321
def _get_all_interface_names(cls):
1308
1322
"""Get a sequence of all interfaces supported by an object"""
1311
1325
for x in (inspect.getmro(cls))
1312
1326
for attr in dir(x))
1313
1327
if name is not None)
1314
1328
1315
1329
@dbus.service.method(dbus.PROPERTIES_IFACE,
1316
1330
in_signature="ss",
1317
1331
out_signature="v")
1325
1339
if not hasattr(value, "variant_level"):
1326
1340
return value
1327
1341
return type(value)(value, variant_level=value.variant_level+1)
1328
1342
1329
1343
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1330
1344
def Set(self, interface_name, property_name, value):
1331
1345
"""Standard D-Bus property Set() method, see D-Bus standard.
1343
1357
value = dbus.ByteArray(b''.join(chr(byte)
1344
1358
for byte in value))
1345
1359
prop(value)
1346
1360
1347
1361
@dbus.service.method(dbus.PROPERTIES_IFACE,
1348
1362
in_signature="s",
1349
1363
out_signature="a{sv}")
1350
1364
def GetAll(self, interface_name):
1351
1365
"""Standard D-Bus property GetAll() method, see D-Bus
1352
1366
standard.
1353
1367
1354
1368
Note: Will not include properties with access="write".
1355
1369
"""
1356
1370
properties = {}
1367
1381
properties[name] = value
1368
1382
continue
1369
1383
properties[name] = type(value)(
1370
value, variant_level = value.variant_level + 1)
1384
value, variant_level=value.variant_level + 1)
1371
1385
return dbus.Dictionary(properties, signature="sv")
1372
1386
1373
1387
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1374
1388
def PropertiesChanged(self, interface_name, changed_properties,
1375
1389
invalidated_properties):
1377
1391
standard.
1378
1392
"""
1379
1393
pass
1380
1394
1381
1395
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1382
1396
out_signature="s",
1383
1397
path_keyword='object_path',
1384
1398
connection_keyword='connection')
1385
1399
def Introspect(self, object_path, connection):
1386
1400
"""Overloading of standard D-Bus method.
1387
1401
1388
1402
Inserts property tags and interface annotation tags.
1389
1403
"""
1390
1404
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1392
1406
connection)
1393
1407
try:
1394
1408
document = xml.dom.minidom.parseString(xmlstring)
1395
1409
1396
1410
def make_tag(document, name, prop):
1397
1411
e = document.createElement("property")
1398
1412
e.setAttribute("name", name)
1399
1413
e.setAttribute("type", prop._dbus_signature)
1400
1414
e.setAttribute("access", prop._dbus_access)
1401
1415
return e
1402
1416
1403
1417
for if_tag in document.getElementsByTagName("interface"):
1404
1418
# Add property tags
1405
1419
for tag in (make_tag(document, name, prop)
1452
1466
except AttributeError:
1453
1467
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1454
1468
1469
1455
1470
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1456
1471
"""A D-Bus object with an ObjectManager.
1457
1472
1458
1473
Classes inheriting from this exposes the standard
1459
1474
GetManagedObjects call and the InterfacesAdded and
1460
1475
InterfacesRemoved signals on the standard
1461
1476
"org.freedesktop.DBus.ObjectManager" interface.
1462
1477
1463
1478
Note: No signals are sent automatically; they must be sent
1464
1479
manually.
1465
1480
"""
1466
1481
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1467
out_signature = "a{oa{sa{sv}}}")
1482
out_signature="a{oa{sa{sv}}}")
1468
1483
def GetManagedObjects(self):
1469
1484
"""This function must be overridden"""
1470
1485
raise NotImplementedError()
1471
1486
1472
1487
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1473
signature = "oa{sa{sv}}")
1488
signature="oa{sa{sv}}")
1474
1489
def InterfacesAdded(self, object_path, interfaces_and_properties):
1475
1490
pass
1476
1477
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1491
1492
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1478
1493
def InterfacesRemoved(self, object_path, interfaces):
1479
1494
pass
1480
1495
1481
1496
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1482
out_signature = "s",
1483
path_keyword = 'object_path',
1484
connection_keyword = 'connection')
1497
out_signature="s",
1498
path_keyword='object_path',
1499
connection_keyword='connection')
1485
1500
def Introspect(self, object_path, connection):
1486
1501
"""Overloading of standard D-Bus method.
1487
1502
1488
1503
Override return argument name of GetManagedObjects to be
1489
1504
"objpath_interfaces_and_properties"
1490
1505
"""
1493
1508
connection)
1494
1509
try:
1495
1510
document = xml.dom.minidom.parseString(xmlstring)
1496
1511
1497
1512
for if_tag in document.getElementsByTagName("interface"):
1498
1513
# Fix argument name for the GetManagedObjects method
1499
1514
if (if_tag.getAttribute("name")
1500
== dbus.OBJECT_MANAGER_IFACE):
1515
== dbus.OBJECT_MANAGER_IFACE):
1501
1516
for cn in if_tag.getElementsByTagName("method"):
1502
1517
if (cn.getAttribute("name")
1503
1518
== "GetManagedObjects"):
1513
1528
except (AttributeError, xml.dom.DOMException,
1514
1529
xml.parsers.expat.ExpatError) as error:
1515
1530
logger.error("Failed to override Introspection method",
1516
exc_info = error)
1531
exc_info=error)
1517
1532
return xmlstring
1518
1533
1534
1519
1535
def datetime_to_dbus(dt, variant_level=0):
1520
1536
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1521
1537
if dt is None:
1522
return dbus.String("", variant_level = variant_level)
1538
return dbus.String("", variant_level=variant_level)
1523
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1524
1540
1525
1541
1528
1544
dbus.service.Object, it will add alternate D-Bus attributes with
1529
1545
interface names according to the "alt_interface_names" mapping.
1530
1546
Usage:
1531
1547
1532
1548
@alternate_dbus_interfaces({"org.example.Interface":
1533
1549
"net.example.AlternateInterface"})
1534
1550
class SampleDBusObject(dbus.service.Object):
1535
1551
@dbus.service.method("org.example.Interface")
1536
1552
def SampleDBusMethod():
1537
1553
pass
1538
1554
1539
1555
The above "SampleDBusMethod" on "SampleDBusObject" will be
1540
1556
reachable via two interfaces: "org.example.Interface" and
1541
1557
"net.example.AlternateInterface", the latter of which will have
1542
1558
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1543
1559
"true", unless "deprecate" is passed with a False value.
1544
1560
1545
1561
This works for methods and signals, and also for D-Bus properties
1546
1562
(from DBusObjectWithProperties) and interfaces (from the
1547
1563
dbus_interface_annotations decorator).
1548
1564
"""
1549
1565
1550
1566
def wrapper(cls):
1551
1567
for orig_interface_name, alt_interface_name in (
1552
1568
alt_interface_names.items()):
1592
1608
attribute._dbus_annotations)
1593
1609
except AttributeError:
1594
1610
pass
1611
1595
1612
# Define a creator of a function to call both the
1596
1613
# original and alternate functions, so both the
1597
1614
# original and alternate signals gets sent when
1600
1617
"""This function is a scope container to pass
1601
1618
func1 and func2 to the "call_both" function
1602
1619
outside of its arguments"""
1603
1620
1604
1621
@functools.wraps(func2)
1605
1622
def call_both(*args, **kwargs):
1606
1623
"""This function will emit two D-Bus
1607
1624
signals by calling func1 and func2"""
1608
1625
func1(*args, **kwargs)
1609
1626
func2(*args, **kwargs)
1610
# Make wrapper function look like a D-Bus signal
1627
# Make wrapper function look like a D-Bus
1628
# signal
1611
1629
for name, attr in inspect.getmembers(func2):
1612
1630
if name.startswith("_dbus_"):
1613
1631
setattr(call_both, name, attr)
1614
1632
1615
1633
return call_both
1616
1634
# Create the "call_both" function and add it to
1617
1635
# the class
1663
1681
(copy_function(attribute)))
1664
1682
if deprecate:
1665
1683
# Deprecate all alternate interfaces
1666
iname="_AlternateDBusNames_interface_annotation{}"
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1667
1685
for interface_name in interface_names:
1668
1686
1669
1687
@dbus_interface_annotations(interface_name)
1670
1688
def func(self):
1671
return { "org.freedesktop.DBus.Deprecated":
1672
"true" }
1689
return {"org.freedesktop.DBus.Deprecated":
1690
"true"}
1673
1691
# Find an unused name
1674
1692
for aname in (iname.format(i)
1675
1693
for i in itertools.count()):
1686
1704
cls = type("{}Alternate".format(cls.__name__),
1687
1705
(cls, ), attr)
1688
1706
return cls
1689
1707
1690
1708
return wrapper
1691
1709
1692
1710
1694
1712
"se.bsnet.fukt.Mandos"})
1695
1713
class ClientDBus(Client, DBusObjectWithProperties):
1696
1714
"""A Client class using D-Bus
1697
1715
1698
1716
Attributes:
1699
1717
dbus_object_path: dbus.ObjectPath
1700
1718
bus: dbus.SystemBus()
1701
1719
"""
1702
1720
1703
1721
runtime_expansions = (Client.runtime_expansions
1704
1722
+ ("dbus_object_path", ))
1705
1723
1706
1724
_interface = "se.recompile.Mandos.Client"
1707
1725
1708
1726
# dbus.service.Object doesn't use super(), so we can't either.
1709
1710
def __init__(self, bus = None, *args, **kwargs):
1727
1728
def __init__(self, bus=None, *args, **kwargs):
1711
1729
self.bus = bus
1712
1730
Client.__init__(self, *args, **kwargs)
1713
1731
# Only now, when this client is initialized, can it show up on
1719
1737
"/clients/" + client_object_name)
1720
1738
DBusObjectWithProperties.__init__(self, self.bus,
1721
1739
self.dbus_object_path)
1722
1740
1723
1741
def notifychangeproperty(transform_func, dbus_name,
1724
1742
type_func=lambda x: x,
1725
1743
variant_level=1,
1727
1745
_interface=_interface):
1728
1746
""" Modify a variable so that it's a property which announces
1729
1747
its changes to DBus.
1730
1748
1731
1749
transform_fun: Function that takes a value and a variant_level
1732
1750
and transforms it to a D-Bus type.
1733
1751
dbus_name: D-Bus name of the variable
1736
1754
variant_level: D-Bus variant level. Default: 1
1737
1755
"""
1738
1756
attrname = "_{}".format(dbus_name)
1739
1757
1740
1758
def setter(self, value):
1741
1759
if hasattr(self, "dbus_object_path"):
1742
1760
if (not hasattr(self, attrname) or
1749
1767
else:
1750
1768
dbus_value = transform_func(
1751
1769
type_func(value),
1752
variant_level = variant_level)
1770
variant_level=variant_level)
1753
1771
self.PropertyChanged(dbus.String(dbus_name),
1754
1772
dbus_value)
1755
1773
self.PropertiesChanged(
1756
1774
_interface,
1757
dbus.Dictionary({ dbus.String(dbus_name):
1758
dbus_value }),
1775
dbus.Dictionary({dbus.String(dbus_name):
1776
dbus_value}),
1759
1777
dbus.Array())
1760
1778
setattr(self, attrname, value)
1761
1779
1762
1780
return property(lambda self: getattr(self, attrname), setter)
1763
1781
1764
1782
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1765
1783
approvals_pending = notifychangeproperty(dbus.Boolean,
1766
1784
"ApprovalPending",
1767
type_func = bool)
1785
type_func=bool)
1768
1786
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1769
1787
last_enabled = notifychangeproperty(datetime_to_dbus,
1770
1788
"LastEnabled")
1771
1789
checker = notifychangeproperty(
1772
1790
dbus.Boolean, "CheckerRunning",
1773
type_func = lambda checker: checker is not None)
1791
type_func=lambda checker: checker is not None)
1774
1792
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1775
1793
"LastCheckedOK")
1776
1794
last_checker_status = notifychangeproperty(dbus.Int16,
1781
1799
"ApprovedByDefault")
1782
1800
approval_delay = notifychangeproperty(
1783
1801
dbus.UInt64, "ApprovalDelay",
1784
type_func = lambda td: td.total_seconds() * 1000)
1802
type_func=lambda td: td.total_seconds() * 1000)
1785
1803
approval_duration = notifychangeproperty(
1786
1804
dbus.UInt64, "ApprovalDuration",
1787
type_func = lambda td: td.total_seconds() * 1000)
1805
type_func=lambda td: td.total_seconds() * 1000)
1788
1806
host = notifychangeproperty(dbus.String, "Host")
1789
1807
timeout = notifychangeproperty(
1790
1808
dbus.UInt64, "Timeout",
1791
type_func = lambda td: td.total_seconds() * 1000)
1809
type_func=lambda td: td.total_seconds() * 1000)
1792
1810
extended_timeout = notifychangeproperty(
1793
1811
dbus.UInt64, "ExtendedTimeout",
1794
type_func = lambda td: td.total_seconds() * 1000)
1812
type_func=lambda td: td.total_seconds() * 1000)
1795
1813
interval = notifychangeproperty(
1796
1814
dbus.UInt64, "Interval",
1797
type_func = lambda td: td.total_seconds() * 1000)
1815
type_func=lambda td: td.total_seconds() * 1000)
1798
1816
checker_command = notifychangeproperty(dbus.String, "Checker")
1799
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1800
1818
invalidate_only=True)
1801
1819
1802
1820
del notifychangeproperty
1803
1821
1804
1822
def __del__(self, *args, **kwargs):
1805
1823
try:
1806
1824
self.remove_from_connection()
1809
1827
if hasattr(DBusObjectWithProperties, "__del__"):
1810
1828
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1811
1829
Client.__del__(self, *args, **kwargs)
1812
1830
1813
1831
def checker_callback(self, source, condition,
1814
1832
connection, command, *args, **kwargs):
1815
1833
ret = Client.checker_callback(self, source, condition,
1831
1849
| self.last_checker_signal),
1832
1850
dbus.String(command))
1833
1851
return ret
1834
1852
1835
1853
def start_checker(self, *args, **kwargs):
1836
1854
old_checker_pid = getattr(self.checker, "pid", None)
1837
1855
r = Client.start_checker(self, *args, **kwargs)
1841
1859
# Emit D-Bus signal
1842
1860
self.CheckerStarted(self.current_checker_command)
1843
1861
return r
1844
1862
1845
1863
def _reset_approved(self):
1846
1864
self.approved = None
1847
1865
return False
1848
1866
1849
1867
def approve(self, value=True):
1850
1868
self.approved = value
1851
1869
GLib.timeout_add(int(self.approval_duration.total_seconds()
1852
1870
* 1000), self._reset_approved)
1853
1871
self.send_changedstate()
1854
1855
## D-Bus methods, signals & properties
1856
1857
## Interfaces
1858
1859
## Signals
1860
1872
1873
# D-Bus methods, signals & properties
1874
1875
# Interfaces
1876
1877
# Signals
1878
1861
1879
# CheckerCompleted - signal
1862
1880
@dbus.service.signal(_interface, signature="nxs")
1863
1881
def CheckerCompleted(self, exitcode, waitstatus, command):
1864
1882
"D-Bus signal"
1865
1883
pass
1866
1884
1867
1885
# CheckerStarted - signal
1868
1886
@dbus.service.signal(_interface, signature="s")
1869
1887
def CheckerStarted(self, command):
1870
1888
"D-Bus signal"
1871
1889
pass
1872
1890
1873
1891
# PropertyChanged - signal
1874
1892
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1875
1893
@dbus.service.signal(_interface, signature="sv")
1876
1894
def PropertyChanged(self, property, value):
1877
1895
"D-Bus signal"
1878
1896
pass
1879
1897
1880
1898
# GotSecret - signal
1881
1899
@dbus.service.signal(_interface)
1882
1900
def GotSecret(self):
1885
1903
server to mandos-client
1886
1904
"""
1887
1905
pass
1888
1906
1889
1907
# Rejected - signal
1890
1908
@dbus.service.signal(_interface, signature="s")
1891
1909
def Rejected(self, reason):
1892
1910
"D-Bus signal"
1893
1911
pass
1894
1912
1895
1913
# NeedApproval - signal
1896
1914
@dbus.service.signal(_interface, signature="tb")
1897
1915
def NeedApproval(self, timeout, default):
1898
1916
"D-Bus signal"
1899
1917
return self.need_approval()
1900
1901
## Methods
1902
1918
1919
# Methods
1920
1903
1921
# Approve - method
1904
1922
@dbus.service.method(_interface, in_signature="b")
1905
1923
def Approve(self, value):
1906
1924
self.approve(value)
1907
1925
1908
1926
# CheckedOK - method
1909
1927
@dbus.service.method(_interface)
1910
1928
def CheckedOK(self):
1911
1929
self.checked_ok()
1912
1930
1913
1931
# Enable - method
1914
1932
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1915
1933
@dbus.service.method(_interface)
1916
1934
def Enable(self):
1917
1935
"D-Bus method"
1918
1936
self.enable()
1919
1937
1920
1938
# StartChecker - method
1921
1939
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1922
1940
@dbus.service.method(_interface)
1923
1941
def StartChecker(self):
1924
1942
"D-Bus method"
1925
1943
self.start_checker()
1926
1944
1927
1945
# Disable - method
1928
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1929
1947
@dbus.service.method(_interface)
1930
1948
def Disable(self):
1931
1949
"D-Bus method"
1932
1950
self.disable()
1933
1951
1934
1952
# StopChecker - method
1935
1953
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1936
1954
@dbus.service.method(_interface)
1937
1955
def StopChecker(self):
1938
1956
self.stop_checker()
1939
1940
## Properties
1941
1957
1958
# Properties
1959
1942
1960
# ApprovalPending - property
1943
1961
@dbus_service_property(_interface, signature="b", access="read")
1944
1962
def ApprovalPending_dbus_property(self):
1945
1963
return dbus.Boolean(bool(self.approvals_pending))
1946
1964
1947
1965
# ApprovedByDefault - property
1948
1966
@dbus_service_property(_interface,
1949
1967
signature="b",
1952
1970
if value is None: # get
1953
1971
return dbus.Boolean(self.approved_by_default)
1954
1972
self.approved_by_default = bool(value)
1955
1973
1956
1974
# ApprovalDelay - property
1957
1975
@dbus_service_property(_interface,
1958
1976
signature="t",
1962
1980
return dbus.UInt64(self.approval_delay.total_seconds()
1963
1981
* 1000)
1964
1982
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1965
1983
1966
1984
# ApprovalDuration - property
1967
1985
@dbus_service_property(_interface,
1968
1986
signature="t",
1972
1990
return dbus.UInt64(self.approval_duration.total_seconds()
1973
1991
* 1000)
1974
1992
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1975
1993
1976
1994
# Name - property
1977
1995
@dbus_annotations(
1978
1996
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1979
1997
@dbus_service_property(_interface, signature="s", access="read")
1980
1998
def Name_dbus_property(self):
1981
1999
return dbus.String(self.name)
1982
2000
1983
2001
# Fingerprint - property
1984
2002
@dbus_annotations(
1985
2003
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
2004
@dbus_service_property(_interface, signature="s", access="read")
1987
2005
def Fingerprint_dbus_property(self):
1988
2006
return dbus.String(self.fingerprint)
1989
2007
1990
2008
# Host - property
1991
2009
@dbus_service_property(_interface,
1992
2010
signature="s",
1995
2013
if value is None: # get
1996
2014
return dbus.String(self.host)
1997
2015
self.host = str(value)
1998
2016
1999
2017
# Created - property
2000
2018
@dbus_annotations(
2001
2019
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2002
2020
@dbus_service_property(_interface, signature="s", access="read")
2003
2021
def Created_dbus_property(self):
2004
2022
return datetime_to_dbus(self.created)
2005
2023
2006
2024
# LastEnabled - property
2007
2025
@dbus_service_property(_interface, signature="s", access="read")
2008
2026
def LastEnabled_dbus_property(self):
2009
2027
return datetime_to_dbus(self.last_enabled)
2010
2028
2011
2029
# Enabled - property
2012
2030
@dbus_service_property(_interface,
2013
2031
signature="b",
2019
2037
self.enable()
2020
2038
else:
2021
2039
self.disable()
2022
2040
2023
2041
# LastCheckedOK - property
2024
2042
@dbus_service_property(_interface,
2025
2043
signature="s",
2029
2047
self.checked_ok()
2030
2048
return
2031
2049
return datetime_to_dbus(self.last_checked_ok)
2032
2050
2033
2051
# LastCheckerStatus - property
2034
2052
@dbus_service_property(_interface, signature="n", access="read")
2035
2053
def LastCheckerStatus_dbus_property(self):
2036
2054
return dbus.Int16(self.last_checker_status)
2037
2055
2038
2056
# Expires - property
2039
2057
@dbus_service_property(_interface, signature="s", access="read")
2040
2058
def Expires_dbus_property(self):
2041
2059
return datetime_to_dbus(self.expires)
2042
2060
2043
2061
# LastApprovalRequest - property
2044
2062
@dbus_service_property(_interface, signature="s", access="read")
2045
2063
def LastApprovalRequest_dbus_property(self):
2046
2064
return datetime_to_dbus(self.last_approval_request)
2047
2065
2048
2066
# Timeout - property
2049
2067
@dbus_service_property(_interface,
2050
2068
signature="t",
2069
2087
self.disable_initiator_tag = GLib.timeout_add(
2070
2088
int((self.expires - now).total_seconds() * 1000),
2071
2089
self.disable)
2072
2090
2073
2091
# ExtendedTimeout - property
2074
2092
@dbus_service_property(_interface,
2075
2093
signature="t",
2079
2097
return dbus.UInt64(self.extended_timeout.total_seconds()
2080
2098
* 1000)
2081
2099
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2082
2100
2083
2101
# Interval - property
2084
2102
@dbus_service_property(_interface,
2085
2103
signature="t",
2095
2113
GLib.source_remove(self.checker_initiator_tag)
2096
2114
self.checker_initiator_tag = GLib.timeout_add(
2097
2115
value, self.start_checker)
2098
self.start_checker() # Start one now, too
2099
2116
self.start_checker() # Start one now, too
2117
2100
2118
# Checker - property
2101
2119
@dbus_service_property(_interface,
2102
2120
signature="s",
2105
2123
if value is None: # get
2106
2124
return dbus.String(self.checker_command)
2107
2125
self.checker_command = str(value)
2108
2126
2109
2127
# CheckerRunning - property
2110
2128
@dbus_service_property(_interface,
2111
2129
signature="b",
2117
2135
self.start_checker()
2118
2136
else:
2119
2137
self.stop_checker()
2120
2138
2121
2139
# ObjectPath - property
2122
2140
@dbus_annotations(
2123
2141
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2124
2142
"org.freedesktop.DBus.Deprecated": "true"})
2125
2143
@dbus_service_property(_interface, signature="o", access="read")
2126
2144
def ObjectPath_dbus_property(self):
2127
return self.dbus_object_path # is already a dbus.ObjectPath
2128
2145
return self.dbus_object_path # is already a dbus.ObjectPath
2146
2129
2147
# Secret = property
2130
2148
@dbus_annotations(
2131
2149
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2136
2154
byte_arrays=True)
2137
2155
def Secret_dbus_property(self, value):
2138
2156
self.secret = bytes(value)
2139
2157
2140
2158
del _interface
2141
2159
2142
2160
2146
2164
self._pipe.send(('init', fpr, address))
2147
2165
if not self._pipe.recv():
2148
2166
raise KeyError(fpr)
2149
2167
2150
2168
def __getattribute__(self, name):
2151
2169
if name == '_pipe':
2152
2170
return super(ProxyClient, self).__getattribute__(name)
2155
2173
if data[0] == 'data':
2156
2174
return data[1]
2157
2175
if data[0] == 'function':
2158
2176
2159
2177
def func(*args, **kwargs):
2160
2178
self._pipe.send(('funcall', name, args, kwargs))
2161
2179
return self._pipe.recv()[1]
2162
2180
2163
2181
return func
2164
2182
2165
2183
def __setattr__(self, name, value):
2166
2184
if name == '_pipe':
2167
2185
return super(ProxyClient, self).__setattr__(name, value)
2170
2188
2171
2189
class ClientHandler(socketserver.BaseRequestHandler, object):
2172
2190
"""A class to handle client connections.
2173
2191
2174
2192
Instantiated once for each connection to handle it.
2175
2193
Note: This will run in its own forked process."""
2176
2194
2177
2195
def handle(self):
2178
2196
with contextlib.closing(self.server.child_pipe) as child_pipe:
2179
2197
logger.info("TCP connection from: %s",
2180
2198
str(self.client_address))
2181
2199
logger.debug("Pipe FD: %d",
2182
2200
self.server.child_pipe.fileno())
2183
2201
2184
2202
session = gnutls.ClientSession(self.request)
2185
2186
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2187
# "+AES-256-CBC", "+SHA1",
2188
# "+COMP-NULL", "+CTYPE-OPENPGP",
2189
# "+DHE-DSS"))
2203
2204
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2205
# "+AES-256-CBC", "+SHA1",
2206
# "+COMP-NULL", "+CTYPE-OPENPGP",
2207
# "+DHE-DSS"))
2190
2208
# Use a fallback default, since this MUST be set.
2191
2209
priority = self.server.gnutls_priority
2192
2210
if priority is None:
2194
2212
gnutls.priority_set_direct(session._c_object,
2195
2213
priority.encode("utf-8"),
2196
2214
None)
2197
2215
2198
2216
# Start communication using the Mandos protocol
2199
2217
# Get protocol number
2200
2218
line = self.request.makefile().readline()
2205
2223
except (ValueError, IndexError, RuntimeError) as error:
2206
2224
logger.error("Unknown protocol version: %s", error)
2207
2225
return
2208
2226
2209
2227
# Start GnuTLS connection
2210
2228
try:
2211
2229
session.handshake()
2215
2233
# established. Just abandon the request.
2216
2234
return
2217
2235
logger.debug("Handshake succeeded")
2218
2236
2219
2237
approval_required = False
2220
2238
try:
2221
2239
try:
2225
2243
logger.warning("Bad certificate: %s", error)
2226
2244
return
2227
2245
logger.debug("Fingerprint: %s", fpr)
2228
2246
2229
2247
try:
2230
2248
client = ProxyClient(child_pipe, fpr,
2231
2249
self.client_address)
2232
2250
except KeyError:
2233
2251
return
2234
2252
2235
2253
if client.approval_delay:
2236
2254
delay = client.approval_delay
2237
2255
client.approvals_pending += 1
2238
2256
approval_required = True
2239
2257
2240
2258
while True:
2241
2259
if not client.enabled:
2242
2260
logger.info("Client %s is disabled",
2245
2263
# Emit D-Bus signal
2246
2264
client.Rejected("Disabled")
2247
2265
return
2248
2266
2249
2267
if client.approved or not client.approval_delay:
2250
#We are approved or approval is disabled
2268
# We are approved or approval is disabled
2251
2269
break
2252
2270
elif client.approved is None:
2253
2271
logger.info("Client %s needs approval",
2264
2282
# Emit D-Bus signal
2265
2283
client.Rejected("Denied")
2266
2284
return
2267
2268
#wait until timeout or approved
2285
2286
# wait until timeout or approved
2269
2287
time = datetime.datetime.now()
2270
2288
client.changedstate.acquire()
2271
2289
client.changedstate.wait(delay.total_seconds())
2284
2302
break
2285
2303
else:
2286
2304
delay -= time2 - time
2287
2305
2288
2306
try:
2289
2307
session.send(client.secret)
2290
2308
except gnutls.Error as error:
2291
2309
logger.warning("gnutls send failed",
2292
exc_info = error)
2310
exc_info=error)
2293
2311
return
2294
2312
2295
2313
logger.info("Sending secret to %s", client.name)
2296
2314
# bump the timeout using extended_timeout
2297
2315
client.bump_timeout(client.extended_timeout)
2298
2316
if self.server.use_dbus:
2299
2317
# Emit D-Bus signal
2300
2318
client.GotSecret()
2301
2319
2302
2320
finally:
2303
2321
if approval_required:
2304
2322
client.approvals_pending -= 1
2307
2325
except gnutls.Error as error:
2308
2326
logger.warning("GnuTLS bye failed",
2309
2327
exc_info=error)
2310
2328
2311
2329
@staticmethod
2312
2330
def peer_certificate(session):
2313
2331
"Return the peer's OpenPGP certificate as a bytestring"
2325
2343
return None
2326
2344
cert = cert_list[0]
2327
2345
return ctypes.string_at(cert.data, cert.size)
2328
2346
2329
2347
@staticmethod
2330
2348
def fingerprint(openpgp):
2331
2349
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2364
2382
2365
2383
class MultiprocessingMixIn(object):
2366
2384
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2367
2385
2368
2386
def sub_process_main(self, request, address):
2369
2387
try:
2370
2388
self.finish_request(request, address)
2371
2389
except Exception:
2372
2390
self.handle_error(request, address)
2373
2391
self.close_request(request)
2374
2392
2375
2393
def process_request(self, request, address):
2376
2394
"""Start a new process to process the request."""
2377
proc = multiprocessing.Process(target = self.sub_process_main,
2378
args = (request, address))
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
2379
2397
proc.start()
2380
2398
return proc
2381
2399
2382
2400
2383
2401
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2384
2402
""" adds a pipe to the MixIn """
2385
2403
2386
2404
def process_request(self, request, client_address):
2387
2405
"""Overrides and wraps the original process_request().
2388
2406
2389
2407
This function creates a new pipe in self.pipe
2390
2408
"""
2391
2409
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2392
2410
2393
2411
proc = MultiprocessingMixIn.process_request(self, request,
2394
2412
client_address)
2395
2413
self.child_pipe.close()
2396
2414
self.add_pipe(parent_pipe, proc)
2397
2415
2398
2416
def add_pipe(self, parent_pipe, proc):
2399
2417
"""Dummy function; override as necessary"""
2400
2418
raise NotImplementedError()
2403
2421
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2404
2422
socketserver.TCPServer, object):
2405
2423
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2406
2424
2407
2425
Attributes:
2408
2426
enabled: Boolean; whether this server is activated yet
2409
2427
interface: None or a network interface name (string)
2410
2428
use_ipv6: Boolean; to use IPv6 or not
2411
2429
"""
2412
2430
2413
2431
def __init__(self, server_address, RequestHandlerClass,
2414
2432
interface=None,
2415
2433
use_ipv6=True,
2425
2443
self.socketfd = socketfd
2426
2444
# Save the original socket.socket() function
2427
2445
self.socket_socket = socket.socket
2446
2428
2447
# To implement --socket, we monkey patch socket.socket.
2429
#
2448
#
2430
2449
# (When socketserver.TCPServer is a new-style class, we
2431
2450
# could make self.socket into a property instead of monkey
2432
2451
# patching socket.socket.)
2433
#
2452
#
2434
2453
# Create a one-time-only replacement for socket.socket()
2435
2454
@functools.wraps(socket.socket)
2436
2455
def socket_wrapper(*args, **kwargs):
2448
2467
# socket_wrapper(), if socketfd was set.
2449
2468
socketserver.TCPServer.__init__(self, server_address,
2450
2469
RequestHandlerClass)
2451
2470
2452
2471
def server_bind(self):
2453
2472
"""This overrides the normal server_bind() function
2454
2473
to bind to an interface if one was specified, and also NOT to
2481
2500
if self.server_address[0] or self.server_address[1]:
2482
2501
if not self.server_address[0]:
2483
2502
if self.address_family == socket.AF_INET6:
2484
any_address = "::" # in6addr_any
2503
any_address = "::" # in6addr_any
2485
2504
else:
2486
any_address = "0.0.0.0" # INADDR_ANY
2505
any_address = "0.0.0.0" # INADDR_ANY
2487
2506
self.server_address = (any_address,
2488
2507
self.server_address[1])
2489
2508
elif not self.server_address[1]:
2499
2518
2500
2519
class MandosServer(IPv6_TCPServer):
2501
2520
"""Mandos server.
2502
2521
2503
2522
Attributes:
2504
2523
clients: set of Client objects
2505
2524
gnutls_priority GnuTLS priority string
2506
2525
use_dbus: Boolean; to emit D-Bus signals or not
2507
2526
2508
2527
Assumes a GLib.MainLoop event loop.
2509
2528
"""
2510
2529
2511
2530
def __init__(self, server_address, RequestHandlerClass,
2512
2531
interface=None,
2513
2532
use_ipv6=True,
2523
2542
self.gnutls_priority = gnutls_priority
2524
2543
IPv6_TCPServer.__init__(self, server_address,
2525
2544
RequestHandlerClass,
2526
interface = interface,
2527
use_ipv6 = use_ipv6,
2528
socketfd = socketfd)
2529
2545
interface=interface,
2546
use_ipv6=use_ipv6,
2547
socketfd=socketfd)
2548
2530
2549
def server_activate(self):
2531
2550
if self.enabled:
2532
2551
return socketserver.TCPServer.server_activate(self)
2533
2552
2534
2553
def enable(self):
2535
2554
self.enabled = True
2536
2555
2537
2556
def add_pipe(self, parent_pipe, proc):
2538
2557
# Call "handle_ipc" for both data and EOF events
2539
2558
GLib.io_add_watch(
2540
2559
parent_pipe.fileno(),
2541
2560
GLib.IO_IN | GLib.IO_HUP,
2542
2561
functools.partial(self.handle_ipc,
2543
parent_pipe = parent_pipe,
2544
proc = proc))
2545
2562
parent_pipe=parent_pipe,
2563
proc=proc))
2564
2546
2565
def handle_ipc(self, source, condition,
2547
2566
parent_pipe=None,
2548
proc = None,
2567
proc=None,
2549
2568
client_object=None):
2550
2569
# error, or the other end of multiprocessing.Pipe has closed
2551
2570
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2552
2571
# Wait for other process to exit
2553
2572
proc.join()
2554
2573
return False
2555
2574
2556
2575
# Read a request from the child
2557
2576
request = parent_pipe.recv()
2558
2577
command = request[0]
2559
2578
2560
2579
if command == 'init':
2561
2580
fpr = request[1]
2562
2581
address = request[2]
2563
2582
2564
2583
for c in self.clients.values():
2565
2584
if c.fingerprint == fpr:
2566
2585
client = c
2574
2593
address[0])
2575
2594
parent_pipe.send(False)
2576
2595
return False
2577
2596
2578
2597
GLib.io_add_watch(
2579
2598
parent_pipe.fileno(),
2580
2599
GLib.IO_IN | GLib.IO_HUP,
2581
2600
functools.partial(self.handle_ipc,
2582
parent_pipe = parent_pipe,
2583
proc = proc,
2584
client_object = client))
2601
parent_pipe=parent_pipe,
2602
proc=proc,
2603
client_object=client))
2585
2604
parent_pipe.send(True)
2586
2605
# remove the old hook in favor of the new above hook on
2587
2606
# same fileno
2590
2609
funcname = request[1]
2591
2610
args = request[2]
2592
2611
kwargs = request[3]
2593
2612
2594
2613
parent_pipe.send(('data', getattr(client_object,
2595
2614
funcname)(*args,
2596
2615
**kwargs)))
2597
2616
2598
2617
if command == 'getattr':
2599
2618
attrname = request[1]
2600
2619
if isinstance(client_object.__getattribute__(attrname),
2603
2622
else:
2604
2623
parent_pipe.send((
2605
2624
'data', client_object.__getattribute__(attrname)))
2606
2625
2607
2626
if command == 'setattr':
2608
2627
attrname = request[1]
2609
2628
value = request[2]
2610
2629
setattr(client_object, attrname, value)
2611
2630
2612
2631
return True
2613
2632
2614
2633
2615
2634
def rfc3339_duration_to_delta(duration):
2616
2635
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2617
2636
2618
2637
>>> rfc3339_duration_to_delta("P7D")
2619
2638
datetime.timedelta(7)
2620
2639
>>> rfc3339_duration_to_delta("PT60S")
2630
2649
>>> rfc3339_duration_to_delta("P1DT3M20S")
2631
2650
datetime.timedelta(1, 200)
2632
2651
"""
2633
2652
2634
2653
# Parsing an RFC 3339 duration with regular expressions is not
2635
2654
# possible - there would have to be multiple places for the same
2636
2655
# values, like seconds. The current code, while more esoteric, is
2637
2656
# cleaner without depending on a parsing library. If Python had a
2638
2657
# built-in library for parsing we would use it, but we'd like to
2639
2658
# avoid excessive use of external libraries.
2640
2659
2641
2660
# New type for defining tokens, syntax, and semantics all-in-one
2642
2661
Token = collections.namedtuple("Token", (
2643
2662
"regexp", # To match token; if "value" is not None, must have
2676
2695
frozenset((token_year, token_month,
2677
2696
token_day, token_time,
2678
2697
token_week)))
2679
# Define starting values
2680
value = datetime.timedelta() # Value so far
2698
# Define starting values:
2699
# Value so far
2700
value = datetime.timedelta()
2681
2701
found_token = None
2682
followers = frozenset((token_duration, )) # Following valid tokens
2683
s = duration # String left to parse
2702
# Following valid tokens
2703
followers = frozenset((token_duration, ))
2704
# String left to parse
2705
s = duration
2684
2706
# Loop until end token is found
2685
2707
while found_token is not token_end:
2686
2708
# Search for any currently valid tokens
2710
2732
2711
2733
def string_to_delta(interval):
2712
2734
"""Parse a string and return a datetime.timedelta
2713
2735
2714
2736
>>> string_to_delta('7d')
2715
2737
datetime.timedelta(7)
2716
2738
>>> string_to_delta('60s')
2724
2746
>>> string_to_delta('5m 30s')
2725
2747
datetime.timedelta(0, 330)
2726
2748
"""
2727
2749
2728
2750
try:
2729
2751
return rfc3339_duration_to_delta(interval)
2730
2752
except ValueError:
2731
2753
pass
2732
2754
2733
2755
timevalue = datetime.timedelta(0)
2734
2756
for s in interval.split():
2735
2757
try:
2753
2775
return timevalue
2754
2776
2755
2777
2756
def daemon(nochdir = False, noclose = False):
2778
def daemon(nochdir=False, noclose=False):
2757
2779
"""See daemon(3). Standard BSD Unix function.
2758
2780
2759
2781
This should really exist as os.daemon, but it doesn't (yet)."""
2760
2782
if os.fork():
2761
2783
sys.exit()
2779
2801
2780
2802
2781
2803
def main():
2782
2804
2783
2805
##################################################################
2784
2806
# Parsing of options, both command line and config file
2785
2807
2786
2808
parser = argparse.ArgumentParser()
2787
2809
parser.add_argument("-v", "--version", action="version",
2788
version = "%(prog)s {}".format(version),
2810
version="%(prog)s {}".format(version),
2789
2811
help="show version number and exit")
2790
2812
parser.add_argument("-i", "--interface", metavar="IF",
2791
2813
help="Bind to interface IF")
2827
2849
parser.add_argument("--no-zeroconf", action="store_false",
2828
2850
dest="zeroconf", help="Do not use Zeroconf",
2829
2851
default=None)
2830
2852
2831
2853
options = parser.parse_args()
2832
2854
2833
2855
if options.check:
2834
2856
import doctest
2835
2857
fail_count, test_count = doctest.testmod()
2836
2858
sys.exit(os.EX_OK if fail_count == 0 else 1)
2837
2859
2838
2860
# Default values for config file for server-global settings
2839
server_defaults = { "interface": "",
2840
"address": "",
2841
"port": "",
2842
"debug": "False",
2843
"priority":
2844
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2845
":+SIGN-DSA-SHA256",
2846
"servicename": "Mandos",
2847
"use_dbus": "True",
2848
"use_ipv6": "True",
2849
"debuglevel": "",
2850
"restore": "True",
2851
"socket": "",
2852
"statedir": "/var/lib/mandos",
2853
"foreground": "False",
2854
"zeroconf": "True",
2855
}
2856
2861
server_defaults = {"interface": "",
2862
"address": "",
2863
"port": "",
2864
"debug": "False",
2865
"priority":
2866
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2867
":+SIGN-DSA-SHA256",
2868
"servicename": "Mandos",
2869
"use_dbus": "True",
2870
"use_ipv6": "True",
2871
"debuglevel": "",
2872
"restore": "True",
2873
"socket": "",
2874
"statedir": "/var/lib/mandos",
2875
"foreground": "False",
2876
"zeroconf": "True",
2877
}
2878
2857
2879
# Parse config file for server-global settings
2858
2880
server_config = configparser.SafeConfigParser(server_defaults)
2859
2881
del server_defaults
2877
2899
server_settings["socket"] = os.dup(server_settings
2878
2900
["socket"])
2879
2901
del server_config
2880
2902
2881
2903
# Override the settings from the config file with command line
2882
2904
# options, if set.
2883
2905
for option in ("interface", "address", "port", "debug",
2901
2923
if server_settings["debug"]:
2902
2924
server_settings["foreground"] = True
2903
2925
# Now we have our good server settings in "server_settings"
2904
2926
2905
2927
##################################################################
2906
2928
2907
2929
if (not server_settings["zeroconf"]
2908
2930
and not (server_settings["port"]
2909
2931
or server_settings["socket"] != "")):
2910
2932
parser.error("Needs port or socket to work without Zeroconf")
2911
2933
2912
2934
# For convenience
2913
2935
debug = server_settings["debug"]
2914
2936
debuglevel = server_settings["debuglevel"]
2918
2940
stored_state_file)
2919
2941
foreground = server_settings["foreground"]
2920
2942
zeroconf = server_settings["zeroconf"]
2921
2943
2922
2944
if debug:
2923
2945
initlogger(debug, logging.DEBUG)
2924
2946
else:
2927
2949
else:
2928
2950
level = getattr(logging, debuglevel.upper())
2929
2951
initlogger(debug, level)
2930
2952
2931
2953
if server_settings["servicename"] != "Mandos":
2932
2954
syslogger.setFormatter(
2933
2955
logging.Formatter('Mandos ({}) [%(process)d]:'
2934
2956
' %(levelname)s: %(message)s'.format(
2935
2957
server_settings["servicename"])))
2936
2958
2937
2959
# Parse config file with clients
2938
2960
client_config = configparser.SafeConfigParser(Client
2939
2961
.client_defaults)
2940
2962
client_config.read(os.path.join(server_settings["configdir"],
2941
2963
"clients.conf"))
2942
2964
2943
2965
global mandos_dbus_service
2944
2966
mandos_dbus_service = None
2945
2967
2946
2968
socketfd = None
2947
2969
if server_settings["socket"] != "":
2948
2970
socketfd = server_settings["socket"]
2964
2986
except IOError as e:
2965
2987
logger.error("Could not open file %r", pidfilename,
2966
2988
exc_info=e)
2967
2989
2968
2990
for name, group in (("_mandos", "_mandos"),
2969
2991
("mandos", "mandos"),
2970
2992
("nobody", "nogroup")):
2988
3010
.format(uid, gid, os.strerror(error.errno)))
2989
3011
if error.errno != errno.EPERM:
2990
3012
raise
2991
3013
2992
3014
if debug:
2993
3015
# Enable all possible GnuTLS debugging
2994
3016
2995
3017
# "Use a log level over 10 to enable all debugging options."
2996
3018
# - GnuTLS manual
2997
3019
gnutls.global_set_log_level(11)
2998
3020
2999
3021
@gnutls.log_func
3000
3022
def debug_gnutls(level, string):
3001
3023
logger.debug("GnuTLS: %s", string[:-1])
3002
3024
3003
3025
gnutls.global_set_log_function(debug_gnutls)
3004
3026
3005
3027
# Redirect stdin so all checkers get /dev/null
3006
3028
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3007
3029
os.dup2(null, sys.stdin.fileno())
3008
3030
if null > 2:
3009
3031
os.close(null)
3010
3032
3011
3033
# Need to fork before connecting to D-Bus
3012
3034
if not foreground:
3013
3035
# Close all input and output, do double fork, etc.
3014
3036
daemon()
3015
3037
3016
3038
# multiprocessing will use threads, so before we use GLib we need
3017
3039
# to inform GLib that threads will be used.
3018
3040
GLib.threads_init()
3019
3041
3020
3042
global main_loop
3021
3043
# From the Avahi example code
3022
3044
DBusGMainLoop(set_as_default=True)
3039
3061
if zeroconf:
3040
3062
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3041
3063
service = AvahiServiceToSyslog(
3042
name = server_settings["servicename"],
3043
servicetype = "_mandos._tcp",
3044
protocol = protocol,
3045
bus = bus)
3064
name=server_settings["servicename"],
3065
servicetype="_mandos._tcp",
3066
protocol=protocol,
3067
bus=bus)
3046
3068
if server_settings["interface"]:
3047
3069
service.interface = if_nametoindex(
3048
3070
server_settings["interface"].encode("utf-8"))
3049
3071
3050
3072
global multiprocessing_manager
3051
3073
multiprocessing_manager = multiprocessing.Manager()
3052
3074
3053
3075
client_class = Client
3054
3076
if use_dbus:
3055
client_class = functools.partial(ClientDBus, bus = bus)
3056
3077
client_class = functools.partial(ClientDBus, bus=bus)
3078
3057
3079
client_settings = Client.config_parser(client_config)
3058
3080
old_client_settings = {}
3059
3081
clients_data = {}
3060
3082
3061
3083
# This is used to redirect stdout and stderr for checker processes
3062
3084
global wnull
3063
wnull = open(os.devnull, "w") # A writable /dev/null
3085
wnull = open(os.devnull, "w") # A writable /dev/null
3064
3086
# Only used if server is running in foreground but not in debug
3065
3087
# mode
3066
3088
if debug or not foreground:
3067
3089
wnull.close()
3068
3090
3069
3091
# Get client data and settings from last running state.
3070
3092
if server_settings["restore"]:
3071
3093
try:
3072
3094
with open(stored_state_path, "rb") as stored_state:
3073
if sys.version_info.major == 2:
3095
if sys.version_info.major == 2:
3074
3096
clients_data, old_client_settings = pickle.load(
3075
3097
stored_state)
3076
3098
else:
3077
3099
bytes_clients_data, bytes_old_client_settings = (
3078
pickle.load(stored_state, encoding = "bytes"))
3079
### Fix bytes to strings
3080
## clients_data
3100
pickle.load(stored_state, encoding="bytes"))
3101
# Fix bytes to strings
3102
# clients_data
3081
3103
# .keys()
3082
clients_data = { (key.decode("utf-8")
3083
if isinstance(key, bytes)
3084
else key): value
3085
for key, value in
3086
bytes_clients_data.items() }
3104
clients_data = {(key.decode("utf-8")
3105
if isinstance(key, bytes)
3106
else key): value
3107
for key, value in
3108
bytes_clients_data.items()}
3087
3109
del bytes_clients_data
3088
3110
for key in clients_data:
3089
value = { (k.decode("utf-8")
3090
if isinstance(k, bytes) else k): v
3091
for k, v in
3092
clients_data[key].items() }
3111
value = {(k.decode("utf-8")
3112
if isinstance(k, bytes) else k): v
3113
for k, v in
3114
clients_data[key].items()}
3093
3115
clients_data[key] = value
3094
3116
# .client_structure
3095
3117
value["client_structure"] = [
3096
3118
(s.decode("utf-8")
3097
3119
if isinstance(s, bytes)
3098
3120
else s) for s in
3099
value["client_structure"] ]
3121
value["client_structure"]]
3100
3122
# .name & .host
3101
3123
for k in ("name", "host"):
3102
3124
if isinstance(value[k], bytes):
3103
3125
value[k] = value[k].decode("utf-8")
3104
## old_client_settings
3126
# old_client_settings
3105
3127
# .keys()
3106
3128
old_client_settings = {
3107
3129
(key.decode("utf-8")
3108
3130
if isinstance(key, bytes)
3109
3131
else key): value
3110
3132
for key, value in
3111
bytes_old_client_settings.items() }
3133
bytes_old_client_settings.items()}
3112
3134
del bytes_old_client_settings
3113
3135
# .host
3114
3136
for value in old_client_settings.values():
3128
3150
logger.warning("Could not load persistent state: "
3129
3151
"EOFError:",
3130
3152
exc_info=e)
3131
3153
3132
3154
with PGPEngine() as pgp:
3133
3155
for client_name, client in clients_data.items():
3134
3156
# Skip removed clients
3135
3157
if client_name not in client_settings:
3136
3158
continue
3137
3159
3138
3160
# Decide which value to use after restoring saved state.
3139
3161
# We have three different values: Old config file,
3140
3162
# new config file, and saved state.
3151
3173
client[name] = value
3152
3174
except KeyError:
3153
3175
pass
3154
3176
3155
3177
# Clients who has passed its expire date can still be
3156
3178
# enabled if its last checker was successful. A Client
3157
3179
# whose checker succeeded before we stored its state is
3190
3212
client_name))
3191
3213
client["secret"] = (client_settings[client_name]
3192
3214
["secret"])
3193
3215
3194
3216
# Add/remove clients based on new changes made to config
3195
3217
for client_name in (set(old_client_settings)
3196
3218
- set(client_settings)):
3198
3220
for client_name in (set(client_settings)
3199
3221
- set(old_client_settings)):
3200
3222
clients_data[client_name] = client_settings[client_name]
3201
3223
3202
3224
# Create all client objects
3203
3225
for client_name, client in clients_data.items():
3204
3226
tcp_server.clients[client_name] = client_class(
3205
name = client_name,
3206
settings = client,
3207
server_settings = server_settings)
3208
3227
name=client_name,
3228
settings=client,
3229
server_settings=server_settings)
3230
3209
3231
if not tcp_server.clients:
3210
3232
logger.warning("No clients defined")
3211
3233
3212
3234
if not foreground:
3213
3235
if pidfile is not None:
3214
3236
pid = os.getpid()
3220
3242
pidfilename, pid)
3221
3243
del pidfile
3222
3244
del pidfilename
3223
3245
3224
3246
for termsig in (signal.SIGHUP, signal.SIGTERM):
3225
3247
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3226
3248
lambda: main_loop.quit() and False)
3227
3249
3228
3250
if use_dbus:
3229
3251
3230
3252
@alternate_dbus_interfaces(
3231
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3253
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3232
3254
class MandosDBusService(DBusObjectWithObjectManager):
3233
3255
"""A D-Bus proxy object"""
3234
3256
3235
3257
def __init__(self):
3236
3258
dbus.service.Object.__init__(self, bus, "/")
3237
3259
3238
3260
_interface = "se.recompile.Mandos"
3239
3261
3240
3262
@dbus.service.signal(_interface, signature="o")
3241
3263
def ClientAdded(self, objpath):
3242
3264
"D-Bus signal"
3243
3265
pass
3244
3266
3245
3267
@dbus.service.signal(_interface, signature="ss")
3246
3268
def ClientNotFound(self, fingerprint, address):
3247
3269
"D-Bus signal"
3248
3270
pass
3249
3271
3250
3272
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3251
3273
"true"})
3252
3274
@dbus.service.signal(_interface, signature="os")
3253
3275
def ClientRemoved(self, objpath, name):
3254
3276
"D-Bus signal"
3255
3277
pass
3256
3278
3257
3279
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3258
3280
"true"})
3259
3281
@dbus.service.method(_interface, out_signature="ao")
3261
3283
"D-Bus method"
3262
3284
return dbus.Array(c.dbus_object_path for c in
3263
3285
tcp_server.clients.values())
3264
3286
3265
3287
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3266
3288
"true"})
3267
3289
@dbus.service.method(_interface,
3269
3291
def GetAllClientsWithProperties(self):
3270
3292
"D-Bus method"
3271
3293
return dbus.Dictionary(
3272
{ c.dbus_object_path: c.GetAll(
3294
{c.dbus_object_path: c.GetAll(
3273
3295
"se.recompile.Mandos.Client")
3274
for c in tcp_server.clients.values() },
3296
for c in tcp_server.clients.values()},
3275
3297
signature="oa{sv}")
3276
3298
3277
3299
@dbus.service.method(_interface, in_signature="o")
3278
3300
def RemoveClient(self, object_path):
3279
3301
"D-Bus method"
3287
3309
self.client_removed_signal(c)
3288
3310
return
3289
3311
raise KeyError(object_path)
3290
3312
3291
3313
del _interface
3292
3314
3293
3315
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3294
out_signature = "a{oa{sa{sv}}}")
3316
out_signature="a{oa{sa{sv}}}")
3295
3317
def GetManagedObjects(self):
3296
3318
"""D-Bus method"""
3297
3319
return dbus.Dictionary(
3298
{ client.dbus_object_path:
3299
dbus.Dictionary(
3300
{ interface: client.GetAll(interface)
3301
for interface in
3302
client._get_all_interface_names()})
3303
for client in tcp_server.clients.values()})
3304
3320
{client.dbus_object_path:
3321
dbus.Dictionary(
3322
{interface: client.GetAll(interface)
3323
for interface in
3324
client._get_all_interface_names()})
3325
for client in tcp_server.clients.values()})
3326
3305
3327
def client_added_signal(self, client):
3306
3328
"""Send the new standard signal and the old signal"""
3307
3329
if use_dbus:
3309
3331
self.InterfacesAdded(
3310
3332
client.dbus_object_path,
3311
3333
dbus.Dictionary(
3312
{ interface: client.GetAll(interface)
3313
for interface in
3314
client._get_all_interface_names()}))
3334
{interface: client.GetAll(interface)
3335
for interface in
3336
client._get_all_interface_names()}))
3315
3337
# Old signal
3316
3338
self.ClientAdded(client.dbus_object_path)
3317
3339
3318
3340
def client_removed_signal(self, client):
3319
3341
"""Send the new standard signal and the old signal"""
3320
3342
if use_dbus:
3325
3347
# Old signal
3326
3348
self.ClientRemoved(client.dbus_object_path,
3327
3349
client.name)
3328
3350
3329
3351
mandos_dbus_service = MandosDBusService()
3330
3352
3331
3353
# Save modules to variables to exempt the modules from being
3332
3354
# unloaded before the function registered with atexit() is run.
3333
3355
mp = multiprocessing
3334
3356
wn = wnull
3357
3335
3358
def cleanup():
3336
3359
"Cleanup function; run on exit"
3337
3360
if zeroconf:
3338
3361
service.cleanup()
3339
3362
3340
3363
mp.active_children()
3341
3364
wn.close()
3342
3365
if not (tcp_server.clients or client_settings):
3343
3366
return
3344
3367
3345
3368
# Store client before exiting. Secrets are encrypted with key
3346
3369
# based on what config file has. If config file is
3347
3370
# removed/edited, old secret will thus be unrecovable.
3352
3375
client.encrypted_secret = pgp.encrypt(client.secret,
3353
3376
key)
3354
3377
client_dict = {}
3355
3378
3356
3379
# A list of attributes that can not be pickled
3357
3380
# + secret.
3358
exclude = { "bus", "changedstate", "secret",
3359
"checker", "server_settings" }
3381
exclude = {"bus", "changedstate", "secret",
3382
"checker", "server_settings"}
3360
3383
for name, typ in inspect.getmembers(dbus.service
3361
3384
.Object):
3362
3385
exclude.add(name)
3363
3386
3364
3387
client_dict["encrypted_secret"] = (client
3365
3388
.encrypted_secret)
3366
3389
for attr in client.client_structure:
3367
3390
if attr not in exclude:
3368
3391
client_dict[attr] = getattr(client, attr)
3369
3392
3370
3393
clients[client.name] = client_dict
3371
3394
del client_settings[client.name]["secret"]
3372
3395
3373
3396
try:
3374
3397
with tempfile.NamedTemporaryFile(
3375
3398
mode='wb',
3378
3401
dir=os.path.dirname(stored_state_path),
3379
3402
delete=False) as stored_state:
3380
3403
pickle.dump((clients, client_settings), stored_state,
3381
protocol = 2)
3404
protocol=2)
3382
3405
tempname = stored_state.name
3383
3406
os.rename(tempname, stored_state_path)
3384
3407
except (IOError, OSError) as e:
3394
3417
logger.warning("Could not save persistent state:",
3395
3418
exc_info=e)
3396
3419
raise
3397
3420
3398
3421
# Delete all clients, and settings from config
3399
3422
while tcp_server.clients:
3400
3423
name, client = tcp_server.clients.popitem()
3406
3429
if use_dbus:
3407
3430
mandos_dbus_service.client_removed_signal(client)
3408
3431
client_settings.clear()
3409
3432
3410
3433
atexit.register(cleanup)
3411
3434
3412
3435
for client in tcp_server.clients.values():
3413
3436
if use_dbus:
3414
3437
# Emit D-Bus signal for adding
3416
3439
# Need to initiate checking of clients
3417
3440
if client.enabled:
3418
3441
client.init_checker()
3419
3442
3420
3443
tcp_server.enable()
3421
3444
tcp_server.server_activate()
3422
3445
3423
3446
# Find out what port we got
3424
3447
if zeroconf:
3425
3448
service.port = tcp_server.socket.getsockname()[1]
3430
3453
else: # IPv4
3431
3454
logger.info("Now listening on address %r, port %d",
3432
3455
*tcp_server.socket.getsockname())
3433
3434
#service.interface = tcp_server.socket.getsockname()[3]
3435
3456
3457
# service.interface = tcp_server.socket.getsockname()[3]
3458
3436
3459
try:
3437
3460
if zeroconf:
3438
3461
# From the Avahi example code
3443
3466
cleanup()
3444
3467
sys.exit(1)
3445
3468
# End of Avahi example code
3446
3469
3447
3470
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3448
3471
lambda *args, **kwargs:
3449
3472
(tcp_server.handle_request
3450
3473
(*args[2:], **kwargs) or True))
3451
3474
3452
3475
logger.debug("Starting main loop")
3453
3476
main_loop.run()
3454
3477
except AvahiError as error:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0