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