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 885
- compare with another revision
- download diff
- download tarball
- view history from revision 885
- Committer: Teddy Hogeborn
- Date: 2016-10-29 14:22:26 UTC
- Revision ID: teddy@recompile.se-20161029142226-n4s9d70tuk615pg1
Makefile: Clarify message when running client.
* Makefile (run-client): Clarify message.
* Makefile (run-client): Clarify message.
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-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 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.13"
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")
1058
1460
exc_info=error)
1059
1461
return xmlstring
1060
1462
1463
try:
1464
dbus.OBJECT_MANAGER_IFACE
1465
except AttributeError:
1466
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1467
1468
1469
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1470
"""A D-Bus object with an ObjectManager.
1471
1472
Classes inheriting from this exposes the standard
1473
GetManagedObjects call and the InterfacesAdded and
1474
InterfacesRemoved signals on the standard
1475
"org.freedesktop.DBus.ObjectManager" interface.
1476
1477
Note: No signals are sent automatically; they must be sent
1478
manually.
1479
"""
1480
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1481
out_signature="a{oa{sa{sv}}}")
1482
def GetManagedObjects(self):
1483
"""This function must be overridden"""
1484
raise NotImplementedError()
1485
1486
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1487
signature="oa{sa{sv}}")
1488
def InterfacesAdded(self, object_path, interfaces_and_properties):
1489
pass
1490
1491
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1492
def InterfacesRemoved(self, object_path, interfaces):
1493
pass
1494
1495
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1496
out_signature="s",
1497
path_keyword='object_path',
1498
connection_keyword='connection')
1499
def Introspect(self, object_path, connection):
1500
"""Overloading of standard D-Bus method.
1501
1502
Override return argument name of GetManagedObjects to be
1503
"objpath_interfaces_and_properties"
1504
"""
1505
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1506
object_path,
1507
connection)
1508
try:
1509
document = xml.dom.minidom.parseString(xmlstring)
1510
1511
for if_tag in document.getElementsByTagName("interface"):
1512
# Fix argument name for the GetManagedObjects method
1513
if (if_tag.getAttribute("name")
1514
== dbus.OBJECT_MANAGER_IFACE):
1515
for cn in if_tag.getElementsByTagName("method"):
1516
if (cn.getAttribute("name")
1517
== "GetManagedObjects"):
1518
for arg in cn.getElementsByTagName("arg"):
1519
if (arg.getAttribute("direction")
1520
== "out"):
1521
arg.setAttribute(
1522
"name",
1523
"objpath_interfaces"
1524
"_and_properties")
1525
xmlstring = document.toxml("utf-8")
1526
document.unlink()
1527
except (AttributeError, xml.dom.DOMException,
1528
xml.parsers.expat.ExpatError) as error:
1529
logger.error("Failed to override Introspection method",
1530
exc_info=error)
1531
return xmlstring
1532
1061
1533
1062
1534
def datetime_to_dbus(dt, variant_level=0):
1063
1535
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1064
1536
if dt is None:
1065
return dbus.String("", variant_level = variant_level)
1537
return dbus.String("", variant_level=variant_level)
1066
1538
return dbus.String(dt.isoformat(), variant_level=variant_level)
1067
1539
1068
1540
1071
1543
dbus.service.Object, it will add alternate D-Bus attributes with
1072
1544
interface names according to the "alt_interface_names" mapping.
1073
1545
Usage:
1074
1546
1075
1547
@alternate_dbus_interfaces({"org.example.Interface":
1076
1548
"net.example.AlternateInterface"})
1077
1549
class SampleDBusObject(dbus.service.Object):
1078
1550
@dbus.service.method("org.example.Interface")
1079
1551
def SampleDBusMethod():
1080
1552
pass
1081
1553
1082
1554
The above "SampleDBusMethod" on "SampleDBusObject" will be
1083
1555
reachable via two interfaces: "org.example.Interface" and
1084
1556
"net.example.AlternateInterface", the latter of which will have
1085
1557
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1086
1558
"true", unless "deprecate" is passed with a False value.
1087
1559
1088
1560
This works for methods and signals, and also for D-Bus properties
1089
1561
(from DBusObjectWithProperties) and interfaces (from the
1090
1562
dbus_interface_annotations decorator).
1091
1563
"""
1092
1564
1093
1565
def wrapper(cls):
1094
1566
for orig_interface_name, alt_interface_name in (
1095
1567
alt_interface_names.items()):
1110
1582
interface_names.add(alt_interface)
1111
1583
# Is this a D-Bus signal?
1112
1584
if getattr(attribute, "_dbus_is_signal", False):
1585
# Extract the original non-method undecorated
1586
# function by black magic
1113
1587
if sys.version_info.major == 2:
1114
# Extract the original non-method undecorated
1115
# function by black magic
1116
1588
nonmethod_func = (dict(
1117
1589
zip(attribute.func_code.co_freevars,
1118
1590
attribute.__closure__))
1119
1591
["func"].cell_contents)
1120
1592
else:
1121
nonmethod_func = attribute
1593
nonmethod_func = (dict(
1594
zip(attribute.__code__.co_freevars,
1595
attribute.__closure__))
1596
["func"].cell_contents)
1122
1597
# Create a new, but exactly alike, function
1123
1598
# object, and decorate it to be a new D-Bus signal
1124
1599
# 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__)
1600
new_function = copy_function(nonmethod_func)
1139
1601
new_function = (dbus.service.signal(
1140
1602
alt_interface,
1141
1603
attribute._dbus_signature)(new_function))
1145
1607
attribute._dbus_annotations)
1146
1608
except AttributeError:
1147
1609
pass
1610
1148
1611
# Define a creator of a function to call both the
1149
1612
# original and alternate functions, so both the
1150
1613
# original and alternate signals gets sent when
1153
1616
"""This function is a scope container to pass
1154
1617
func1 and func2 to the "call_both" function
1155
1618
outside of its arguments"""
1156
1619
1620
@functools.wraps(func2)
1157
1621
def call_both(*args, **kwargs):
1158
1622
"""This function will emit two D-Bus
1159
1623
signals by calling func1 and func2"""
1160
1624
func1(*args, **kwargs)
1161
1625
func2(*args, **kwargs)
1162
1626
# Make wrapper function look like a D-Bus
1627
# signal
1628
for name, attr in inspect.getmembers(func2):
1629
if name.startswith("_dbus_"):
1630
setattr(call_both, name, attr)
1631
1163
1632
return call_both
1164
1633
# Create the "call_both" function and add it to
1165
1634
# the class
1175
1644
alt_interface,
1176
1645
attribute._dbus_in_signature,
1177
1646
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)))
1647
(copy_function(attribute)))
1183
1648
# Copy annotations, if any
1184
1649
try:
1185
1650
attr[attrname]._dbus_annotations = dict(
1197
1662
attribute._dbus_access,
1198
1663
attribute._dbus_get_args_options
1199
1664
["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)))
1665
(copy_function(attribute)))
1206
1666
# Copy annotations, if any
1207
1667
try:
1208
1668
attr[attrname]._dbus_annotations = dict(
1217
1677
# to the class.
1218
1678
attr[attrname] = (
1219
1679
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)))
1680
(copy_function(attribute)))
1225
1681
if deprecate:
1226
1682
# Deprecate all alternate interfaces
1227
iname="_AlternateDBusNames_interface_annotation{}"
1683
iname = "_AlternateDBusNames_interface_annotation{}"
1228
1684
for interface_name in interface_names:
1229
1685
1230
1686
@dbus_interface_annotations(interface_name)
1231
1687
def func(self):
1232
return { "org.freedesktop.DBus.Deprecated":
1233
"true" }
1688
return {"org.freedesktop.DBus.Deprecated":
1689
"true"}
1234
1690
# Find an unused name
1235
1691
for aname in (iname.format(i)
1236
1692
for i in itertools.count()):
1240
1696
if interface_names:
1241
1697
# Replace the class with a new subclass of it with
1242
1698
# methods, signals, etc. as created above.
1243
cls = type(b"{}Alternate".format(cls.__name__),
1244
(cls, ), attr)
1699
if sys.version_info.major == 2:
1700
cls = type(b"{}Alternate".format(cls.__name__),
1701
(cls, ), attr)
1702
else:
1703
cls = type("{}Alternate".format(cls.__name__),
1704
(cls, ), attr)
1245
1705
return cls
1246
1706
1247
1707
return wrapper
1248
1708
1249
1709
1251
1711
"se.bsnet.fukt.Mandos"})
1252
1712
class ClientDBus(Client, DBusObjectWithProperties):
1253
1713
"""A Client class using D-Bus
1254
1714
1255
1715
Attributes:
1256
1716
dbus_object_path: dbus.ObjectPath
1257
1717
bus: dbus.SystemBus()
1258
1718
"""
1259
1719
1260
1720
runtime_expansions = (Client.runtime_expansions
1261
1721
+ ("dbus_object_path", ))
1262
1722
1263
1723
_interface = "se.recompile.Mandos.Client"
1264
1724
1265
1725
# dbus.service.Object doesn't use super(), so we can't either.
1266
1267
def __init__(self, bus = None, *args, **kwargs):
1726
1727
def __init__(self, bus=None, *args, **kwargs):
1268
1728
self.bus = bus
1269
1729
Client.__init__(self, *args, **kwargs)
1270
1730
# Only now, when this client is initialized, can it show up on
1276
1736
"/clients/" + client_object_name)
1277
1737
DBusObjectWithProperties.__init__(self, self.bus,
1278
1738
self.dbus_object_path)
1279
1739
1280
1740
def notifychangeproperty(transform_func, dbus_name,
1281
1741
type_func=lambda x: x,
1282
1742
variant_level=1,
1284
1744
_interface=_interface):
1285
1745
""" Modify a variable so that it's a property which announces
1286
1746
its changes to DBus.
1287
1747
1288
1748
transform_fun: Function that takes a value and a variant_level
1289
1749
and transforms it to a D-Bus type.
1290
1750
dbus_name: D-Bus name of the variable
1293
1753
variant_level: D-Bus variant level. Default: 1
1294
1754
"""
1295
1755
attrname = "_{}".format(dbus_name)
1296
1756
1297
1757
def setter(self, value):
1298
1758
if hasattr(self, "dbus_object_path"):
1299
1759
if (not hasattr(self, attrname) or
1306
1766
else:
1307
1767
dbus_value = transform_func(
1308
1768
type_func(value),
1309
variant_level = variant_level)
1769
variant_level=variant_level)
1310
1770
self.PropertyChanged(dbus.String(dbus_name),
1311
1771
dbus_value)
1312
1772
self.PropertiesChanged(
1313
1773
_interface,
1314
dbus.Dictionary({ dbus.String(dbus_name):
1315
dbus_value }),
1774
dbus.Dictionary({dbus.String(dbus_name):
1775
dbus_value}),
1316
1776
dbus.Array())
1317
1777
setattr(self, attrname, value)
1318
1778
1319
1779
return property(lambda self: getattr(self, attrname), setter)
1320
1780
1321
1781
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1322
1782
approvals_pending = notifychangeproperty(dbus.Boolean,
1323
1783
"ApprovalPending",
1324
type_func = bool)
1784
type_func=bool)
1325
1785
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1326
1786
last_enabled = notifychangeproperty(datetime_to_dbus,
1327
1787
"LastEnabled")
1328
1788
checker = notifychangeproperty(
1329
1789
dbus.Boolean, "CheckerRunning",
1330
type_func = lambda checker: checker is not None)
1790
type_func=lambda checker: checker is not None)
1331
1791
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1332
1792
"LastCheckedOK")
1333
1793
last_checker_status = notifychangeproperty(dbus.Int16,
1338
1798
"ApprovedByDefault")
1339
1799
approval_delay = notifychangeproperty(
1340
1800
dbus.UInt64, "ApprovalDelay",
1341
type_func = lambda td: td.total_seconds() * 1000)
1801
type_func=lambda td: td.total_seconds() * 1000)
1342
1802
approval_duration = notifychangeproperty(
1343
1803
dbus.UInt64, "ApprovalDuration",
1344
type_func = lambda td: td.total_seconds() * 1000)
1804
type_func=lambda td: td.total_seconds() * 1000)
1345
1805
host = notifychangeproperty(dbus.String, "Host")
1346
1806
timeout = notifychangeproperty(
1347
1807
dbus.UInt64, "Timeout",
1348
type_func = lambda td: td.total_seconds() * 1000)
1808
type_func=lambda td: td.total_seconds() * 1000)
1349
1809
extended_timeout = notifychangeproperty(
1350
1810
dbus.UInt64, "ExtendedTimeout",
1351
type_func = lambda td: td.total_seconds() * 1000)
1811
type_func=lambda td: td.total_seconds() * 1000)
1352
1812
interval = notifychangeproperty(
1353
1813
dbus.UInt64, "Interval",
1354
type_func = lambda td: td.total_seconds() * 1000)
1814
type_func=lambda td: td.total_seconds() * 1000)
1355
1815
checker_command = notifychangeproperty(dbus.String, "Checker")
1356
1816
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1357
1817
invalidate_only=True)
1358
1818
1359
1819
del notifychangeproperty
1360
1820
1361
1821
def __del__(self, *args, **kwargs):
1362
1822
try:
1363
1823
self.remove_from_connection()
1366
1826
if hasattr(DBusObjectWithProperties, "__del__"):
1367
1827
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1368
1828
Client.__del__(self, *args, **kwargs)
1369
1829
1370
1830
def checker_callback(self, source, condition,
1371
1831
connection, command, *args, **kwargs):
1372
1832
ret = Client.checker_callback(self, source, condition,
1388
1848
| self.last_checker_signal),
1389
1849
dbus.String(command))
1390
1850
return ret
1391
1851
1392
1852
def start_checker(self, *args, **kwargs):
1393
1853
old_checker_pid = getattr(self.checker, "pid", None)
1394
1854
r = Client.start_checker(self, *args, **kwargs)
1398
1858
# Emit D-Bus signal
1399
1859
self.CheckerStarted(self.current_checker_command)
1400
1860
return r
1401
1861
1402
1862
def _reset_approved(self):
1403
1863
self.approved = None
1404
1864
return False
1405
1865
1406
1866
def approve(self, value=True):
1407
1867
self.approved = value
1408
gobject.timeout_add(int(self.approval_duration.total_seconds()
1409
* 1000), self._reset_approved)
1868
GLib.timeout_add(int(self.approval_duration.total_seconds()
1869
* 1000), self._reset_approved)
1410
1870
self.send_changedstate()
1411
1412
## D-Bus methods, signals & properties
1413
1414
## Interfaces
1415
1416
## Signals
1417
1871
1872
# D-Bus methods, signals & properties
1873
1874
# Interfaces
1875
1876
# Signals
1877
1418
1878
# CheckerCompleted - signal
1419
1879
@dbus.service.signal(_interface, signature="nxs")
1420
1880
def CheckerCompleted(self, exitcode, waitstatus, command):
1421
1881
"D-Bus signal"
1422
1882
pass
1423
1883
1424
1884
# CheckerStarted - signal
1425
1885
@dbus.service.signal(_interface, signature="s")
1426
1886
def CheckerStarted(self, command):
1427
1887
"D-Bus signal"
1428
1888
pass
1429
1889
1430
1890
# PropertyChanged - signal
1431
1891
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1432
1892
@dbus.service.signal(_interface, signature="sv")
1433
1893
def PropertyChanged(self, property, value):
1434
1894
"D-Bus signal"
1435
1895
pass
1436
1896
1437
1897
# GotSecret - signal
1438
1898
@dbus.service.signal(_interface)
1439
1899
def GotSecret(self):
1442
1902
server to mandos-client
1443
1903
"""
1444
1904
pass
1445
1905
1446
1906
# Rejected - signal
1447
1907
@dbus.service.signal(_interface, signature="s")
1448
1908
def Rejected(self, reason):
1449
1909
"D-Bus signal"
1450
1910
pass
1451
1911
1452
1912
# NeedApproval - signal
1453
1913
@dbus.service.signal(_interface, signature="tb")
1454
1914
def NeedApproval(self, timeout, default):
1455
1915
"D-Bus signal"
1456
1916
return self.need_approval()
1457
1458
## Methods
1459
1917
1918
# Methods
1919
1460
1920
# Approve - method
1461
1921
@dbus.service.method(_interface, in_signature="b")
1462
1922
def Approve(self, value):
1463
1923
self.approve(value)
1464
1924
1465
1925
# CheckedOK - method
1466
1926
@dbus.service.method(_interface)
1467
1927
def CheckedOK(self):
1468
1928
self.checked_ok()
1469
1929
1470
1930
# Enable - method
1471
1931
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1472
1932
@dbus.service.method(_interface)
1473
1933
def Enable(self):
1474
1934
"D-Bus method"
1475
1935
self.enable()
1476
1936
1477
1937
# StartChecker - method
1478
1938
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1479
1939
@dbus.service.method(_interface)
1480
1940
def StartChecker(self):
1481
1941
"D-Bus method"
1482
1942
self.start_checker()
1483
1943
1484
1944
# Disable - method
1485
1945
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1486
1946
@dbus.service.method(_interface)
1487
1947
def Disable(self):
1488
1948
"D-Bus method"
1489
1949
self.disable()
1490
1950
1491
1951
# StopChecker - method
1492
1952
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1493
1953
@dbus.service.method(_interface)
1494
1954
def StopChecker(self):
1495
1955
self.stop_checker()
1496
1497
## Properties
1498
1956
1957
# Properties
1958
1499
1959
# ApprovalPending - property
1500
1960
@dbus_service_property(_interface, signature="b", access="read")
1501
1961
def ApprovalPending_dbus_property(self):
1502
1962
return dbus.Boolean(bool(self.approvals_pending))
1503
1963
1504
1964
# ApprovedByDefault - property
1505
1965
@dbus_service_property(_interface,
1506
1966
signature="b",
1509
1969
if value is None: # get
1510
1970
return dbus.Boolean(self.approved_by_default)
1511
1971
self.approved_by_default = bool(value)
1512
1972
1513
1973
# ApprovalDelay - property
1514
1974
@dbus_service_property(_interface,
1515
1975
signature="t",
1519
1979
return dbus.UInt64(self.approval_delay.total_seconds()
1520
1980
* 1000)
1521
1981
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1522
1982
1523
1983
# ApprovalDuration - property
1524
1984
@dbus_service_property(_interface,
1525
1985
signature="t",
1529
1989
return dbus.UInt64(self.approval_duration.total_seconds()
1530
1990
* 1000)
1531
1991
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1532
1992
1533
1993
# Name - property
1534
1994
@dbus_annotations(
1535
1995
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1536
1996
@dbus_service_property(_interface, signature="s", access="read")
1537
1997
def Name_dbus_property(self):
1538
1998
return dbus.String(self.name)
1539
1999
1540
2000
# Fingerprint - property
1541
2001
@dbus_annotations(
1542
2002
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1543
2003
@dbus_service_property(_interface, signature="s", access="read")
1544
2004
def Fingerprint_dbus_property(self):
1545
2005
return dbus.String(self.fingerprint)
1546
2006
1547
2007
# Host - property
1548
2008
@dbus_service_property(_interface,
1549
2009
signature="s",
1552
2012
if value is None: # get
1553
2013
return dbus.String(self.host)
1554
2014
self.host = str(value)
1555
2015
1556
2016
# Created - property
1557
2017
@dbus_annotations(
1558
2018
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1559
2019
@dbus_service_property(_interface, signature="s", access="read")
1560
2020
def Created_dbus_property(self):
1561
2021
return datetime_to_dbus(self.created)
1562
2022
1563
2023
# LastEnabled - property
1564
2024
@dbus_service_property(_interface, signature="s", access="read")
1565
2025
def LastEnabled_dbus_property(self):
1566
2026
return datetime_to_dbus(self.last_enabled)
1567
2027
1568
2028
# Enabled - property
1569
2029
@dbus_service_property(_interface,
1570
2030
signature="b",
1576
2036
self.enable()
1577
2037
else:
1578
2038
self.disable()
1579
2039
1580
2040
# LastCheckedOK - property
1581
2041
@dbus_service_property(_interface,
1582
2042
signature="s",
1586
2046
self.checked_ok()
1587
2047
return
1588
2048
return datetime_to_dbus(self.last_checked_ok)
1589
2049
1590
2050
# LastCheckerStatus - property
1591
2051
@dbus_service_property(_interface, signature="n", access="read")
1592
2052
def LastCheckerStatus_dbus_property(self):
1593
2053
return dbus.Int16(self.last_checker_status)
1594
2054
1595
2055
# Expires - property
1596
2056
@dbus_service_property(_interface, signature="s", access="read")
1597
2057
def Expires_dbus_property(self):
1598
2058
return datetime_to_dbus(self.expires)
1599
2059
1600
2060
# LastApprovalRequest - property
1601
2061
@dbus_service_property(_interface, signature="s", access="read")
1602
2062
def LastApprovalRequest_dbus_property(self):
1603
2063
return datetime_to_dbus(self.last_approval_request)
1604
2064
1605
2065
# Timeout - property
1606
2066
@dbus_service_property(_interface,
1607
2067
signature="t",
1622
2082
if (getattr(self, "disable_initiator_tag", None)
1623
2083
is None):
1624
2084
return
1625
gobject.source_remove(self.disable_initiator_tag)
1626
self.disable_initiator_tag = gobject.timeout_add(
2085
GLib.source_remove(self.disable_initiator_tag)
2086
self.disable_initiator_tag = GLib.timeout_add(
1627
2087
int((self.expires - now).total_seconds() * 1000),
1628
2088
self.disable)
1629
2089
1630
2090
# ExtendedTimeout - property
1631
2091
@dbus_service_property(_interface,
1632
2092
signature="t",
1636
2096
return dbus.UInt64(self.extended_timeout.total_seconds()
1637
2097
* 1000)
1638
2098
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1639
2099
1640
2100
# Interval - property
1641
2101
@dbus_service_property(_interface,
1642
2102
signature="t",
1649
2109
return
1650
2110
if self.enabled:
1651
2111
# Reschedule checker run
1652
gobject.source_remove(self.checker_initiator_tag)
1653
self.checker_initiator_tag = gobject.timeout_add(
2112
GLib.source_remove(self.checker_initiator_tag)
2113
self.checker_initiator_tag = GLib.timeout_add(
1654
2114
value, self.start_checker)
1655
self.start_checker() # Start one now, too
1656
2115
self.start_checker() # Start one now, too
2116
1657
2117
# Checker - property
1658
2118
@dbus_service_property(_interface,
1659
2119
signature="s",
1662
2122
if value is None: # get
1663
2123
return dbus.String(self.checker_command)
1664
2124
self.checker_command = str(value)
1665
2125
1666
2126
# CheckerRunning - property
1667
2127
@dbus_service_property(_interface,
1668
2128
signature="b",
1674
2134
self.start_checker()
1675
2135
else:
1676
2136
self.stop_checker()
1677
2137
1678
2138
# ObjectPath - property
1679
2139
@dbus_annotations(
1680
2140
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
1681
2141
"org.freedesktop.DBus.Deprecated": "true"})
1682
2142
@dbus_service_property(_interface, signature="o", access="read")
1683
2143
def ObjectPath_dbus_property(self):
1684
return self.dbus_object_path # is already a dbus.ObjectPath
1685
2144
return self.dbus_object_path # is already a dbus.ObjectPath
2145
1686
2146
# Secret = property
1687
2147
@dbus_annotations(
1688
2148
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
1693
2153
byte_arrays=True)
1694
2154
def Secret_dbus_property(self, value):
1695
2155
self.secret = bytes(value)
1696
2156
1697
2157
del _interface
1698
2158
1699
2159
1703
2163
self._pipe.send(('init', fpr, address))
1704
2164
if not self._pipe.recv():
1705
2165
raise KeyError(fpr)
1706
2166
1707
2167
def __getattribute__(self, name):
1708
2168
if name == '_pipe':
1709
2169
return super(ProxyClient, self).__getattribute__(name)
1712
2172
if data[0] == 'data':
1713
2173
return data[1]
1714
2174
if data[0] == 'function':
1715
2175
1716
2176
def func(*args, **kwargs):
1717
2177
self._pipe.send(('funcall', name, args, kwargs))
1718
2178
return self._pipe.recv()[1]
1719
2179
1720
2180
return func
1721
2181
1722
2182
def __setattr__(self, name, value):
1723
2183
if name == '_pipe':
1724
2184
return super(ProxyClient, self).__setattr__(name, value)
1727
2187
1728
2188
class ClientHandler(socketserver.BaseRequestHandler, object):
1729
2189
"""A class to handle client connections.
1730
2190
1731
2191
Instantiated once for each connection to handle it.
1732
2192
Note: This will run in its own forked process."""
1733
2193
1734
2194
def handle(self):
1735
2195
with contextlib.closing(self.server.child_pipe) as child_pipe:
1736
2196
logger.info("TCP connection from: %s",
1737
2197
str(self.client_address))
1738
2198
logger.debug("Pipe FD: %d",
1739
2199
self.server.child_pipe.fileno())
1740
1741
session = gnutls.connection.ClientSession(
1742
self.request, gnutls.connection .X509Credentials())
1743
1744
# Note: gnutls.connection.X509Credentials is really a
1745
# generic GnuTLS certificate credentials object so long as
1746
# no X.509 keys are added to it. Therefore, we can use it
1747
# here despite using OpenPGP certificates.
1748
1749
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1750
# "+AES-256-CBC", "+SHA1",
1751
# "+COMP-NULL", "+CTYPE-OPENPGP",
1752
# "+DHE-DSS"))
2200
2201
session = gnutls.ClientSession(self.request)
2202
2203
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2204
# "+AES-256-CBC", "+SHA1",
2205
# "+COMP-NULL", "+CTYPE-OPENPGP",
2206
# "+DHE-DSS"))
1753
2207
# Use a fallback default, since this MUST be set.
1754
2208
priority = self.server.gnutls_priority
1755
2209
if priority is None:
1756
2210
priority = "NORMAL"
1757
gnutls.library.functions.gnutls_priority_set_direct(
1758
session._c_object, priority, None)
1759
2211
gnutls.priority_set_direct(session._c_object,
2212
priority.encode("utf-8"),
2213
None)
2214
1760
2215
# Start communication using the Mandos protocol
1761
2216
# Get protocol number
1762
2217
line = self.request.makefile().readline()
1767
2222
except (ValueError, IndexError, RuntimeError) as error:
1768
2223
logger.error("Unknown protocol version: %s", error)
1769
2224
return
1770
2225
1771
2226
# Start GnuTLS connection
1772
2227
try:
1773
2228
session.handshake()
1774
except gnutls.errors.GNUTLSError as error:
2229
except gnutls.Error as error:
1775
2230
logger.warning("Handshake failed: %s", error)
1776
2231
# Do not run session.bye() here: the session is not
1777
2232
# established. Just abandon the request.
1778
2233
return
1779
2234
logger.debug("Handshake succeeded")
1780
2235
1781
2236
approval_required = False
1782
2237
try:
1783
2238
try:
1784
2239
fpr = self.fingerprint(
1785
2240
self.peer_certificate(session))
1786
except (TypeError,
1787
gnutls.errors.GNUTLSError) as error:
2241
except (TypeError, gnutls.Error) as error:
1788
2242
logger.warning("Bad certificate: %s", error)
1789
2243
return
1790
2244
logger.debug("Fingerprint: %s", fpr)
1791
2245
1792
2246
try:
1793
2247
client = ProxyClient(child_pipe, fpr,
1794
2248
self.client_address)
1795
2249
except KeyError:
1796
2250
return
1797
2251
1798
2252
if client.approval_delay:
1799
2253
delay = client.approval_delay
1800
2254
client.approvals_pending += 1
1801
2255
approval_required = True
1802
2256
1803
2257
while True:
1804
2258
if not client.enabled:
1805
2259
logger.info("Client %s is disabled",
1808
2262
# Emit D-Bus signal
1809
2263
client.Rejected("Disabled")
1810
2264
return
1811
2265
1812
2266
if client.approved or not client.approval_delay:
1813
#We are approved or approval is disabled
2267
# We are approved or approval is disabled
1814
2268
break
1815
2269
elif client.approved is None:
1816
2270
logger.info("Client %s needs approval",
1827
2281
# Emit D-Bus signal
1828
2282
client.Rejected("Denied")
1829
2283
return
1830
1831
#wait until timeout or approved
2284
2285
# wait until timeout or approved
1832
2286
time = datetime.datetime.now()
1833
2287
client.changedstate.acquire()
1834
2288
client.changedstate.wait(delay.total_seconds())
1847
2301
break
1848
2302
else:
1849
2303
delay -= time2 - time
1850
1851
sent_size = 0
1852
while sent_size < len(client.secret):
1853
try:
1854
sent = session.send(client.secret[sent_size:])
1855
except gnutls.errors.GNUTLSError as error:
1856
logger.warning("gnutls send failed",
1857
exc_info=error)
1858
return
1859
logger.debug("Sent: %d, remaining: %d", sent,
1860
len(client.secret) - (sent_size
1861
+ sent))
1862
sent_size += sent
1863
2304
2305
try:
2306
session.send(client.secret)
2307
except gnutls.Error as error:
2308
logger.warning("gnutls send failed",
2309
exc_info=error)
2310
return
2311
1864
2312
logger.info("Sending secret to %s", client.name)
1865
2313
# bump the timeout using extended_timeout
1866
2314
client.bump_timeout(client.extended_timeout)
1867
2315
if self.server.use_dbus:
1868
2316
# Emit D-Bus signal
1869
2317
client.GotSecret()
1870
2318
1871
2319
finally:
1872
2320
if approval_required:
1873
2321
client.approvals_pending -= 1
1874
2322
try:
1875
2323
session.bye()
1876
except gnutls.errors.GNUTLSError as error:
2324
except gnutls.Error as error:
1877
2325
logger.warning("GnuTLS bye failed",
1878
2326
exc_info=error)
1879
2327
1880
2328
@staticmethod
1881
2329
def peer_certificate(session):
1882
2330
"Return the peer's OpenPGP certificate as a bytestring"
1883
2331
# If not an OpenPGP certificate...
1884
if (gnutls.library.functions.gnutls_certificate_type_get(
1885
session._c_object)
1886
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1887
# ...do the normal thing
1888
return session.peer_certificate
2332
if (gnutls.certificate_type_get(session._c_object)
2333
!= gnutls.CRT_OPENPGP):
2334
# ...return invalid data
2335
return b""
1889
2336
list_size = ctypes.c_uint(1)
1890
cert_list = (gnutls.library.functions
1891
.gnutls_certificate_get_peers
2337
cert_list = (gnutls.certificate_get_peers
1892
2338
(session._c_object, ctypes.byref(list_size)))
1893
2339
if not bool(cert_list) and list_size.value != 0:
1894
raise gnutls.errors.GNUTLSError("error getting peer"
1895
" certificate")
2340
raise gnutls.Error("error getting peer certificate")
1896
2341
if list_size.value == 0:
1897
2342
return None
1898
2343
cert = cert_list[0]
1899
2344
return ctypes.string_at(cert.data, cert.size)
1900
2345
1901
2346
@staticmethod
1902
2347
def fingerprint(openpgp):
1903
2348
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1904
2349
# New GnuTLS "datum" with the OpenPGP public key
1905
datum = gnutls.library.types.gnutls_datum_t(
2350
datum = gnutls.datum_t(
1906
2351
ctypes.cast(ctypes.c_char_p(openpgp),
1907
2352
ctypes.POINTER(ctypes.c_ubyte)),
1908
2353
ctypes.c_uint(len(openpgp)))
1909
2354
# New empty GnuTLS certificate
1910
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1911
gnutls.library.functions.gnutls_openpgp_crt_init(
1912
ctypes.byref(crt))
2355
crt = gnutls.openpgp_crt_t()
2356
gnutls.openpgp_crt_init(ctypes.byref(crt))
1913
2357
# Import the OpenPGP public key into the certificate
1914
gnutls.library.functions.gnutls_openpgp_crt_import(
1915
crt, ctypes.byref(datum),
1916
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
2358
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2359
gnutls.OPENPGP_FMT_RAW)
1917
2360
# Verify the self signature in the key
1918
2361
crtverify = ctypes.c_uint()
1919
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1920
crt, 0, ctypes.byref(crtverify))
2362
gnutls.openpgp_crt_verify_self(crt, 0,
2363
ctypes.byref(crtverify))
1921
2364
if crtverify.value != 0:
1922
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1923
raise gnutls.errors.CertificateSecurityError(
1924
"Verify failed")
2365
gnutls.openpgp_crt_deinit(crt)
2366
raise gnutls.CertificateSecurityError("Verify failed")
1925
2367
# New buffer for the fingerprint
1926
2368
buf = ctypes.create_string_buffer(20)
1927
2369
buf_len = ctypes.c_size_t()
1928
2370
# Get the fingerprint from the certificate into the buffer
1929
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1930
crt, ctypes.byref(buf), ctypes.byref(buf_len))
2371
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2372
ctypes.byref(buf_len))
1931
2373
# Deinit the certificate
1932
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2374
gnutls.openpgp_crt_deinit(crt)
1933
2375
# Convert the buffer to a Python bytestring
1934
2376
fpr = ctypes.string_at(buf, buf_len.value)
1935
2377
# Convert the bytestring to hexadecimal notation
1939
2381
1940
2382
class MultiprocessingMixIn(object):
1941
2383
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1942
2384
1943
2385
def sub_process_main(self, request, address):
1944
2386
try:
1945
2387
self.finish_request(request, address)
1946
2388
except Exception:
1947
2389
self.handle_error(request, address)
1948
2390
self.close_request(request)
1949
2391
1950
2392
def process_request(self, request, address):
1951
2393
"""Start a new process to process the request."""
1952
proc = multiprocessing.Process(target = self.sub_process_main,
1953
args = (request, address))
2394
proc = multiprocessing.Process(target=self.sub_process_main,
2395
args=(request, address))
1954
2396
proc.start()
1955
2397
return proc
1956
2398
1957
2399
1958
2400
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1959
2401
""" adds a pipe to the MixIn """
1960
2402
1961
2403
def process_request(self, request, client_address):
1962
2404
"""Overrides and wraps the original process_request().
1963
2405
1964
2406
This function creates a new pipe in self.pipe
1965
2407
"""
1966
2408
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1967
2409
1968
2410
proc = MultiprocessingMixIn.process_request(self, request,
1969
2411
client_address)
1970
2412
self.child_pipe.close()
1971
2413
self.add_pipe(parent_pipe, proc)
1972
2414
1973
2415
def add_pipe(self, parent_pipe, proc):
1974
2416
"""Dummy function; override as necessary"""
1975
2417
raise NotImplementedError()
1978
2420
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1979
2421
socketserver.TCPServer, object):
1980
2422
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1981
2423
1982
2424
Attributes:
1983
2425
enabled: Boolean; whether this server is activated yet
1984
2426
interface: None or a network interface name (string)
1985
2427
use_ipv6: Boolean; to use IPv6 or not
1986
2428
"""
1987
2429
1988
2430
def __init__(self, server_address, RequestHandlerClass,
1989
2431
interface=None,
1990
2432
use_ipv6=True,
2000
2442
self.socketfd = socketfd
2001
2443
# Save the original socket.socket() function
2002
2444
self.socket_socket = socket.socket
2445
2003
2446
# To implement --socket, we monkey patch socket.socket.
2004
#
2447
#
2005
2448
# (When socketserver.TCPServer is a new-style class, we
2006
2449
# could make self.socket into a property instead of monkey
2007
2450
# patching socket.socket.)
2008
#
2451
#
2009
2452
# Create a one-time-only replacement for socket.socket()
2010
2453
@functools.wraps(socket.socket)
2011
2454
def socket_wrapper(*args, **kwargs):
2023
2466
# socket_wrapper(), if socketfd was set.
2024
2467
socketserver.TCPServer.__init__(self, server_address,
2025
2468
RequestHandlerClass)
2026
2469
2027
2470
def server_bind(self):
2028
2471
"""This overrides the normal server_bind() function
2029
2472
to bind to an interface if one was specified, and also NOT to
2030
2473
bind to an address or port if they were not specified."""
2474
global SO_BINDTODEVICE
2031
2475
if self.interface is not None:
2032
2476
if SO_BINDTODEVICE is None:
2033
logger.error("SO_BINDTODEVICE does not exist;"
2034
" cannot bind to interface %s",
2035
self.interface)
2036
else:
2037
try:
2038
self.socket.setsockopt(
2039
socket.SOL_SOCKET, SO_BINDTODEVICE,
2040
(self.interface + "\0").encode("utf-8"))
2041
except socket.error as error:
2042
if error.errno == errno.EPERM:
2043
logger.error("No permission to bind to"
2044
" interface %s", self.interface)
2045
elif error.errno == errno.ENOPROTOOPT:
2046
logger.error("SO_BINDTODEVICE not available;"
2047
" cannot bind to interface %s",
2048
self.interface)
2049
elif error.errno == errno.ENODEV:
2050
logger.error("Interface %s does not exist,"
2051
" cannot bind", self.interface)
2052
else:
2053
raise
2477
# Fall back to a hard-coded value which seems to be
2478
# common enough.
2479
logger.warning("SO_BINDTODEVICE not found, trying 25")
2480
SO_BINDTODEVICE = 25
2481
try:
2482
self.socket.setsockopt(
2483
socket.SOL_SOCKET, SO_BINDTODEVICE,
2484
(self.interface + "\0").encode("utf-8"))
2485
except socket.error as error:
2486
if error.errno == errno.EPERM:
2487
logger.error("No permission to bind to"
2488
" interface %s", self.interface)
2489
elif error.errno == errno.ENOPROTOOPT:
2490
logger.error("SO_BINDTODEVICE not available;"
2491
" cannot bind to interface %s",
2492
self.interface)
2493
elif error.errno == errno.ENODEV:
2494
logger.error("Interface %s does not exist,"
2495
" cannot bind", self.interface)
2496
else:
2497
raise
2054
2498
# Only bind(2) the socket if we really need to.
2055
2499
if self.server_address[0] or self.server_address[1]:
2056
2500
if not self.server_address[0]:
2057
2501
if self.address_family == socket.AF_INET6:
2058
any_address = "::" # in6addr_any
2502
any_address = "::" # in6addr_any
2059
2503
else:
2060
any_address = "0.0.0.0" # INADDR_ANY
2504
any_address = "0.0.0.0" # INADDR_ANY
2061
2505
self.server_address = (any_address,
2062
2506
self.server_address[1])
2063
2507
elif not self.server_address[1]:
2073
2517
2074
2518
class MandosServer(IPv6_TCPServer):
2075
2519
"""Mandos server.
2076
2520
2077
2521
Attributes:
2078
2522
clients: set of Client objects
2079
2523
gnutls_priority GnuTLS priority string
2080
2524
use_dbus: Boolean; to emit D-Bus signals or not
2081
2082
Assumes a gobject.MainLoop event loop.
2525
2526
Assumes a GLib.MainLoop event loop.
2083
2527
"""
2084
2528
2085
2529
def __init__(self, server_address, RequestHandlerClass,
2086
2530
interface=None,
2087
2531
use_ipv6=True,
2097
2541
self.gnutls_priority = gnutls_priority
2098
2542
IPv6_TCPServer.__init__(self, server_address,
2099
2543
RequestHandlerClass,
2100
interface = interface,
2101
use_ipv6 = use_ipv6,
2102
socketfd = socketfd)
2103
2544
interface=interface,
2545
use_ipv6=use_ipv6,
2546
socketfd=socketfd)
2547
2104
2548
def server_activate(self):
2105
2549
if self.enabled:
2106
2550
return socketserver.TCPServer.server_activate(self)
2107
2551
2108
2552
def enable(self):
2109
2553
self.enabled = True
2110
2554
2111
2555
def add_pipe(self, parent_pipe, proc):
2112
2556
# Call "handle_ipc" for both data and EOF events
2113
gobject.io_add_watch(
2557
GLib.io_add_watch(
2114
2558
parent_pipe.fileno(),
2115
gobject.IO_IN | gobject.IO_HUP,
2559
GLib.IO_IN | GLib.IO_HUP,
2116
2560
functools.partial(self.handle_ipc,
2117
parent_pipe = parent_pipe,
2118
proc = proc))
2119
2561
parent_pipe=parent_pipe,
2562
proc=proc))
2563
2120
2564
def handle_ipc(self, source, condition,
2121
2565
parent_pipe=None,
2122
proc = None,
2566
proc=None,
2123
2567
client_object=None):
2124
2568
# error, or the other end of multiprocessing.Pipe has closed
2125
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2569
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2126
2570
# Wait for other process to exit
2127
2571
proc.join()
2128
2572
return False
2129
2573
2130
2574
# Read a request from the child
2131
2575
request = parent_pipe.recv()
2132
2576
command = request[0]
2133
2577
2134
2578
if command == 'init':
2135
2579
fpr = request[1]
2136
2580
address = request[2]
2137
2138
for c in self.clients.itervalues():
2581
2582
for c in self.clients.values():
2139
2583
if c.fingerprint == fpr:
2140
2584
client = c
2141
2585
break
2148
2592
address[0])
2149
2593
parent_pipe.send(False)
2150
2594
return False
2151
2152
gobject.io_add_watch(
2595
2596
GLib.io_add_watch(
2153
2597
parent_pipe.fileno(),
2154
gobject.IO_IN | gobject.IO_HUP,
2598
GLib.IO_IN | GLib.IO_HUP,
2155
2599
functools.partial(self.handle_ipc,
2156
parent_pipe = parent_pipe,
2157
proc = proc,
2158
client_object = client))
2600
parent_pipe=parent_pipe,
2601
proc=proc,
2602
client_object=client))
2159
2603
parent_pipe.send(True)
2160
2604
# remove the old hook in favor of the new above hook on
2161
2605
# same fileno
2164
2608
funcname = request[1]
2165
2609
args = request[2]
2166
2610
kwargs = request[3]
2167
2611
2168
2612
parent_pipe.send(('data', getattr(client_object,
2169
2613
funcname)(*args,
2170
2614
**kwargs)))
2171
2615
2172
2616
if command == 'getattr':
2173
2617
attrname = request[1]
2174
2618
if isinstance(client_object.__getattribute__(attrname),
2177
2621
else:
2178
2622
parent_pipe.send((
2179
2623
'data', client_object.__getattribute__(attrname)))
2180
2624
2181
2625
if command == 'setattr':
2182
2626
attrname = request[1]
2183
2627
value = request[2]
2184
2628
setattr(client_object, attrname, value)
2185
2629
2186
2630
return True
2187
2631
2188
2632
2189
2633
def rfc3339_duration_to_delta(duration):
2190
2634
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2191
2635
2192
2636
>>> rfc3339_duration_to_delta("P7D")
2193
2637
datetime.timedelta(7)
2194
2638
>>> rfc3339_duration_to_delta("PT60S")
2204
2648
>>> rfc3339_duration_to_delta("P1DT3M20S")
2205
2649
datetime.timedelta(1, 200)
2206
2650
"""
2207
2651
2208
2652
# Parsing an RFC 3339 duration with regular expressions is not
2209
2653
# possible - there would have to be multiple places for the same
2210
2654
# values, like seconds. The current code, while more esoteric, is
2211
2655
# cleaner without depending on a parsing library. If Python had a
2212
2656
# built-in library for parsing we would use it, but we'd like to
2213
2657
# avoid excessive use of external libraries.
2214
2658
2215
2659
# New type for defining tokens, syntax, and semantics all-in-one
2216
2660
Token = collections.namedtuple("Token", (
2217
2661
"regexp", # To match token; if "value" is not None, must have
2250
2694
frozenset((token_year, token_month,
2251
2695
token_day, token_time,
2252
2696
token_week)))
2253
# Define starting values
2254
value = datetime.timedelta() # Value so far
2697
# Define starting values:
2698
# Value so far
2699
value = datetime.timedelta()
2255
2700
found_token = None
2256
followers = frozenset((token_duration, )) # Following valid tokens
2257
s = duration # String left to parse
2701
# Following valid tokens
2702
followers = frozenset((token_duration, ))
2703
# String left to parse
2704
s = duration
2258
2705
# Loop until end token is found
2259
2706
while found_token is not token_end:
2260
2707
# Search for any currently valid tokens
2284
2731
2285
2732
def string_to_delta(interval):
2286
2733
"""Parse a string and return a datetime.timedelta
2287
2734
2288
2735
>>> string_to_delta('7d')
2289
2736
datetime.timedelta(7)
2290
2737
>>> string_to_delta('60s')
2298
2745
>>> string_to_delta('5m 30s')
2299
2746
datetime.timedelta(0, 330)
2300
2747
"""
2301
2748
2302
2749
try:
2303
2750
return rfc3339_duration_to_delta(interval)
2304
2751
except ValueError:
2305
2752
pass
2306
2753
2307
2754
timevalue = datetime.timedelta(0)
2308
2755
for s in interval.split():
2309
2756
try:
2327
2774
return timevalue
2328
2775
2329
2776
2330
def daemon(nochdir = False, noclose = False):
2777
def daemon(nochdir=False, noclose=False):
2331
2778
"""See daemon(3). Standard BSD Unix function.
2332
2779
2333
2780
This should really exist as os.daemon, but it doesn't (yet)."""
2334
2781
if os.fork():
2335
2782
sys.exit()
2353
2800
2354
2801
2355
2802
def main():
2356
2803
2357
2804
##################################################################
2358
2805
# Parsing of options, both command line and config file
2359
2806
2360
2807
parser = argparse.ArgumentParser()
2361
2808
parser.add_argument("-v", "--version", action="version",
2362
version = "%(prog)s {}".format(version),
2809
version="%(prog)s {}".format(version),
2363
2810
help="show version number and exit")
2364
2811
parser.add_argument("-i", "--interface", metavar="IF",
2365
2812
help="Bind to interface IF")
2401
2848
parser.add_argument("--no-zeroconf", action="store_false",
2402
2849
dest="zeroconf", help="Do not use Zeroconf",
2403
2850
default=None)
2404
2851
2405
2852
options = parser.parse_args()
2406
2853
2407
2854
if options.check:
2408
2855
import doctest
2409
2856
fail_count, test_count = doctest.testmod()
2410
2857
sys.exit(os.EX_OK if fail_count == 0 else 1)
2411
2858
2412
2859
# Default values for config file for server-global settings
2413
server_defaults = { "interface": "",
2414
"address": "",
2415
"port": "",
2416
"debug": "False",
2417
"priority":
2418
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2419
":+SIGN-DSA-SHA256",
2420
"servicename": "Mandos",
2421
"use_dbus": "True",
2422
"use_ipv6": "True",
2423
"debuglevel": "",
2424
"restore": "True",
2425
"socket": "",
2426
"statedir": "/var/lib/mandos",
2427
"foreground": "False",
2428
"zeroconf": "True",
2429
}
2430
2860
server_defaults = {"interface": "",
2861
"address": "",
2862
"port": "",
2863
"debug": "False",
2864
"priority":
2865
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2866
":+SIGN-DSA-SHA256",
2867
"servicename": "Mandos",
2868
"use_dbus": "True",
2869
"use_ipv6": "True",
2870
"debuglevel": "",
2871
"restore": "True",
2872
"socket": "",
2873
"statedir": "/var/lib/mandos",
2874
"foreground": "False",
2875
"zeroconf": "True",
2876
}
2877
2431
2878
# Parse config file for server-global settings
2432
2879
server_config = configparser.SafeConfigParser(server_defaults)
2433
2880
del server_defaults
2451
2898
server_settings["socket"] = os.dup(server_settings
2452
2899
["socket"])
2453
2900
del server_config
2454
2901
2455
2902
# Override the settings from the config file with command line
2456
2903
# options, if set.
2457
2904
for option in ("interface", "address", "port", "debug",
2475
2922
if server_settings["debug"]:
2476
2923
server_settings["foreground"] = True
2477
2924
# Now we have our good server settings in "server_settings"
2478
2925
2479
2926
##################################################################
2480
2927
2481
2928
if (not server_settings["zeroconf"]
2482
2929
and not (server_settings["port"]
2483
2930
or server_settings["socket"] != "")):
2484
2931
parser.error("Needs port or socket to work without Zeroconf")
2485
2932
2486
2933
# For convenience
2487
2934
debug = server_settings["debug"]
2488
2935
debuglevel = server_settings["debuglevel"]
2492
2939
stored_state_file)
2493
2940
foreground = server_settings["foreground"]
2494
2941
zeroconf = server_settings["zeroconf"]
2495
2942
2496
2943
if debug:
2497
2944
initlogger(debug, logging.DEBUG)
2498
2945
else:
2501
2948
else:
2502
2949
level = getattr(logging, debuglevel.upper())
2503
2950
initlogger(debug, level)
2504
2951
2505
2952
if server_settings["servicename"] != "Mandos":
2506
2953
syslogger.setFormatter(
2507
2954
logging.Formatter('Mandos ({}) [%(process)d]:'
2508
2955
' %(levelname)s: %(message)s'.format(
2509
2956
server_settings["servicename"])))
2510
2957
2511
2958
# Parse config file with clients
2512
2959
client_config = configparser.SafeConfigParser(Client
2513
2960
.client_defaults)
2514
2961
client_config.read(os.path.join(server_settings["configdir"],
2515
2962
"clients.conf"))
2516
2963
2517
2964
global mandos_dbus_service
2518
2965
mandos_dbus_service = None
2519
2966
2520
2967
socketfd = None
2521
2968
if server_settings["socket"] != "":
2522
2969
socketfd = server_settings["socket"]
2538
2985
except IOError as e:
2539
2986
logger.error("Could not open file %r", pidfilename,
2540
2987
exc_info=e)
2541
2542
for name in ("_mandos", "mandos", "nobody"):
2988
2989
for name, group in (("_mandos", "_mandos"),
2990
("mandos", "mandos"),
2991
("nobody", "nogroup")):
2543
2992
try:
2544
2993
uid = pwd.getpwnam(name).pw_uid
2545
gid = pwd.getpwnam(name).pw_gid
2994
gid = pwd.getpwnam(group).pw_gid
2546
2995
break
2547
2996
except KeyError:
2548
2997
continue
2552
3001
try:
2553
3002
os.setgid(gid)
2554
3003
os.setuid(uid)
3004
if debug:
3005
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3006
gid))
2555
3007
except OSError as error:
3008
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3009
.format(uid, gid, os.strerror(error.errno)))
2556
3010
if error.errno != errno.EPERM:
2557
3011
raise
2558
3012
2559
3013
if debug:
2560
3014
# Enable all possible GnuTLS debugging
2561
3015
2562
3016
# "Use a log level over 10 to enable all debugging options."
2563
3017
# - GnuTLS manual
2564
gnutls.library.functions.gnutls_global_set_log_level(11)
2565
2566
@gnutls.library.types.gnutls_log_func
3018
gnutls.global_set_log_level(11)
3019
3020
@gnutls.log_func
2567
3021
def debug_gnutls(level, string):
2568
3022
logger.debug("GnuTLS: %s", string[:-1])
2569
2570
gnutls.library.functions.gnutls_global_set_log_function(
2571
debug_gnutls)
2572
3023
3024
gnutls.global_set_log_function(debug_gnutls)
3025
2573
3026
# Redirect stdin so all checkers get /dev/null
2574
3027
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2575
3028
os.dup2(null, sys.stdin.fileno())
2576
3029
if null > 2:
2577
3030
os.close(null)
2578
3031
2579
3032
# Need to fork before connecting to D-Bus
2580
3033
if not foreground:
2581
3034
# Close all input and output, do double fork, etc.
2582
3035
daemon()
2583
2584
# multiprocessing will use threads, so before we use gobject we
2585
# need to inform gobject that threads will be used.
2586
gobject.threads_init()
2587
3036
3037
# multiprocessing will use threads, so before we use GLib we need
3038
# to inform GLib that threads will be used.
3039
GLib.threads_init()
3040
2588
3041
global main_loop
2589
3042
# From the Avahi example code
2590
3043
DBusGMainLoop(set_as_default=True)
2591
main_loop = gobject.MainLoop()
3044
main_loop = GLib.MainLoop()
2592
3045
bus = dbus.SystemBus()
2593
3046
# End of Avahi example code
2594
3047
if use_dbus:
2607
3060
if zeroconf:
2608
3061
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2609
3062
service = AvahiServiceToSyslog(
2610
name = server_settings["servicename"],
2611
servicetype = "_mandos._tcp",
2612
protocol = protocol,
2613
bus = bus)
3063
name=server_settings["servicename"],
3064
servicetype="_mandos._tcp",
3065
protocol=protocol,
3066
bus=bus)
2614
3067
if server_settings["interface"]:
2615
3068
service.interface = if_nametoindex(
2616
3069
server_settings["interface"].encode("utf-8"))
2617
3070
2618
3071
global multiprocessing_manager
2619
3072
multiprocessing_manager = multiprocessing.Manager()
2620
3073
2621
3074
client_class = Client
2622
3075
if use_dbus:
2623
client_class = functools.partial(ClientDBus, bus = bus)
2624
3076
client_class = functools.partial(ClientDBus, bus=bus)
3077
2625
3078
client_settings = Client.config_parser(client_config)
2626
3079
old_client_settings = {}
2627
3080
clients_data = {}
2628
3081
2629
3082
# This is used to redirect stdout and stderr for checker processes
2630
3083
global wnull
2631
wnull = open(os.devnull, "w") # A writable /dev/null
3084
wnull = open(os.devnull, "w") # A writable /dev/null
2632
3085
# Only used if server is running in foreground but not in debug
2633
3086
# mode
2634
3087
if debug or not foreground:
2635
3088
wnull.close()
2636
3089
2637
3090
# Get client data and settings from last running state.
2638
3091
if server_settings["restore"]:
2639
3092
try:
2640
3093
with open(stored_state_path, "rb") as stored_state:
2641
clients_data, old_client_settings = pickle.load(
2642
stored_state)
3094
if sys.version_info.major == 2:
3095
clients_data, old_client_settings = pickle.load(
3096
stored_state)
3097
else:
3098
bytes_clients_data, bytes_old_client_settings = (
3099
pickle.load(stored_state, encoding="bytes"))
3100
# Fix bytes to strings
3101
# clients_data
3102
# .keys()
3103
clients_data = {(key.decode("utf-8")
3104
if isinstance(key, bytes)
3105
else key): value
3106
for key, value in
3107
bytes_clients_data.items()}
3108
del bytes_clients_data
3109
for key in clients_data:
3110
value = {(k.decode("utf-8")
3111
if isinstance(k, bytes) else k): v
3112
for k, v in
3113
clients_data[key].items()}
3114
clients_data[key] = value
3115
# .client_structure
3116
value["client_structure"] = [
3117
(s.decode("utf-8")
3118
if isinstance(s, bytes)
3119
else s) for s in
3120
value["client_structure"]]
3121
# .name & .host
3122
for k in ("name", "host"):
3123
if isinstance(value[k], bytes):
3124
value[k] = value[k].decode("utf-8")
3125
# old_client_settings
3126
# .keys()
3127
old_client_settings = {
3128
(key.decode("utf-8")
3129
if isinstance(key, bytes)
3130
else key): value
3131
for key, value in
3132
bytes_old_client_settings.items()}
3133
del bytes_old_client_settings
3134
# .host
3135
for value in old_client_settings.values():
3136
if isinstance(value["host"], bytes):
3137
value["host"] = (value["host"]
3138
.decode("utf-8"))
2643
3139
os.remove(stored_state_path)
2644
3140
except IOError as e:
2645
3141
if e.errno == errno.ENOENT:
2653
3149
logger.warning("Could not load persistent state: "
2654
3150
"EOFError:",
2655
3151
exc_info=e)
2656
3152
2657
3153
with PGPEngine() as pgp:
2658
3154
for client_name, client in clients_data.items():
2659
3155
# Skip removed clients
2660
3156
if client_name not in client_settings:
2661
3157
continue
2662
3158
2663
3159
# Decide which value to use after restoring saved state.
2664
3160
# We have three different values: Old config file,
2665
3161
# new config file, and saved state.
2676
3172
client[name] = value
2677
3173
except KeyError:
2678
3174
pass
2679
3175
2680
3176
# Clients who has passed its expire date can still be
2681
3177
# enabled if its last checker was successful. A Client
2682
3178
# whose checker succeeded before we stored its state is
2715
3211
client_name))
2716
3212
client["secret"] = (client_settings[client_name]
2717
3213
["secret"])
2718
3214
2719
3215
# Add/remove clients based on new changes made to config
2720
3216
for client_name in (set(old_client_settings)
2721
3217
- set(client_settings)):
2723
3219
for client_name in (set(client_settings)
2724
3220
- set(old_client_settings)):
2725
3221
clients_data[client_name] = client_settings[client_name]
2726
3222
2727
3223
# Create all client objects
2728
3224
for client_name, client in clients_data.items():
2729
3225
tcp_server.clients[client_name] = client_class(
2730
name = client_name,
2731
settings = client,
2732
server_settings = server_settings)
2733
3226
name=client_name,
3227
settings=client,
3228
server_settings=server_settings)
3229
2734
3230
if not tcp_server.clients:
2735
3231
logger.warning("No clients defined")
2736
3232
2737
3233
if not foreground:
2738
3234
if pidfile is not None:
2739
3235
pid = os.getpid()
2745
3241
pidfilename, pid)
2746
3242
del pidfile
2747
3243
del pidfilename
2748
2749
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2750
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2751
3244
3245
for termsig in (signal.SIGHUP, signal.SIGTERM):
3246
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3247
lambda: main_loop.quit() and False)
3248
2752
3249
if use_dbus:
2753
3250
2754
3251
@alternate_dbus_interfaces(
2755
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2756
class MandosDBusService(DBusObjectWithProperties):
3252
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3253
class MandosDBusService(DBusObjectWithObjectManager):
2757
3254
"""A D-Bus proxy object"""
2758
3255
2759
3256
def __init__(self):
2760
3257
dbus.service.Object.__init__(self, bus, "/")
2761
3258
2762
3259
_interface = "se.recompile.Mandos"
2763
2764
@dbus_interface_annotations(_interface)
2765
def _foo(self):
2766
return {
2767
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2768
"false" }
2769
3260
2770
3261
@dbus.service.signal(_interface, signature="o")
2771
3262
def ClientAdded(self, objpath):
2772
3263
"D-Bus signal"
2773
3264
pass
2774
3265
2775
3266
@dbus.service.signal(_interface, signature="ss")
2776
3267
def ClientNotFound(self, fingerprint, address):
2777
3268
"D-Bus signal"
2778
3269
pass
2779
3270
3271
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3272
"true"})
2780
3273
@dbus.service.signal(_interface, signature="os")
2781
3274
def ClientRemoved(self, objpath, name):
2782
3275
"D-Bus signal"
2783
3276
pass
2784
3277
3278
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3279
"true"})
2785
3280
@dbus.service.method(_interface, out_signature="ao")
2786
3281
def GetAllClients(self):
2787
3282
"D-Bus method"
2788
3283
return dbus.Array(c.dbus_object_path for c in
2789
tcp_server.clients.itervalues())
2790
3284
tcp_server.clients.values())
3285
3286
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3287
"true"})
2791
3288
@dbus.service.method(_interface,
2792
3289
out_signature="a{oa{sv}}")
2793
3290
def GetAllClientsWithProperties(self):
2794
3291
"D-Bus method"
2795
3292
return dbus.Dictionary(
2796
{ c.dbus_object_path: c.GetAll("")
2797
for c in tcp_server.clients.itervalues() },
3293
{c.dbus_object_path: c.GetAll(
3294
"se.recompile.Mandos.Client")
3295
for c in tcp_server.clients.values()},
2798
3296
signature="oa{sv}")
2799
3297
2800
3298
@dbus.service.method(_interface, in_signature="o")
2801
3299
def RemoveClient(self, object_path):
2802
3300
"D-Bus method"
2803
for c in tcp_server.clients.itervalues():
3301
for c in tcp_server.clients.values():
2804
3302
if c.dbus_object_path == object_path:
2805
3303
del tcp_server.clients[c.name]
2806
3304
c.remove_from_connection()
2807
# Don't signal anything except ClientRemoved
3305
# Don't signal the disabling
2808
3306
c.disable(quiet=True)
2809
# Emit D-Bus signal
2810
self.ClientRemoved(object_path, c.name)
3307
# Emit D-Bus signal for removal
3308
self.client_removed_signal(c)
2811
3309
return
2812
3310
raise KeyError(object_path)
2813
3311
2814
3312
del _interface
2815
3313
3314
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3315
out_signature="a{oa{sa{sv}}}")
3316
def GetManagedObjects(self):
3317
"""D-Bus method"""
3318
return dbus.Dictionary(
3319
{client.dbus_object_path:
3320
dbus.Dictionary(
3321
{interface: client.GetAll(interface)
3322
for interface in
3323
client._get_all_interface_names()})
3324
for client in tcp_server.clients.values()})
3325
3326
def client_added_signal(self, client):
3327
"""Send the new standard signal and the old signal"""
3328
if use_dbus:
3329
# New standard signal
3330
self.InterfacesAdded(
3331
client.dbus_object_path,
3332
dbus.Dictionary(
3333
{interface: client.GetAll(interface)
3334
for interface in
3335
client._get_all_interface_names()}))
3336
# Old signal
3337
self.ClientAdded(client.dbus_object_path)
3338
3339
def client_removed_signal(self, client):
3340
"""Send the new standard signal and the old signal"""
3341
if use_dbus:
3342
# New standard signal
3343
self.InterfacesRemoved(
3344
client.dbus_object_path,
3345
client._get_all_interface_names())
3346
# Old signal
3347
self.ClientRemoved(client.dbus_object_path,
3348
client.name)
3349
2816
3350
mandos_dbus_service = MandosDBusService()
2817
3351
3352
# Save modules to variables to exempt the modules from being
3353
# unloaded before the function registered with atexit() is run.
3354
mp = multiprocessing
3355
wn = wnull
3356
2818
3357
def cleanup():
2819
3358
"Cleanup function; run on exit"
2820
3359
if zeroconf:
2821
3360
service.cleanup()
2822
2823
multiprocessing.active_children()
2824
wnull.close()
3361
3362
mp.active_children()
3363
wn.close()
2825
3364
if not (tcp_server.clients or client_settings):
2826
3365
return
2827
3366
2828
3367
# Store client before exiting. Secrets are encrypted with key
2829
3368
# based on what config file has. If config file is
2830
3369
# removed/edited, old secret will thus be unrecovable.
2831
3370
clients = {}
2832
3371
with PGPEngine() as pgp:
2833
for client in tcp_server.clients.itervalues():
3372
for client in tcp_server.clients.values():
2834
3373
key = client_settings[client.name]["secret"]
2835
3374
client.encrypted_secret = pgp.encrypt(client.secret,
2836
3375
key)
2837
3376
client_dict = {}
2838
3377
2839
3378
# A list of attributes that can not be pickled
2840
3379
# + secret.
2841
exclude = { "bus", "changedstate", "secret",
2842
"checker", "server_settings" }
3380
exclude = {"bus", "changedstate", "secret",
3381
"checker", "server_settings"}
2843
3382
for name, typ in inspect.getmembers(dbus.service
2844
3383
.Object):
2845
3384
exclude.add(name)
2846
3385
2847
3386
client_dict["encrypted_secret"] = (client
2848
3387
.encrypted_secret)
2849
3388
for attr in client.client_structure:
2850
3389
if attr not in exclude:
2851
3390
client_dict[attr] = getattr(client, attr)
2852
3391
2853
3392
clients[client.name] = client_dict
2854
3393
del client_settings[client.name]["secret"]
2855
3394
2856
3395
try:
2857
3396
with tempfile.NamedTemporaryFile(
2858
3397
mode='wb',
2860
3399
prefix='clients-',
2861
3400
dir=os.path.dirname(stored_state_path),
2862
3401
delete=False) as stored_state:
2863
pickle.dump((clients, client_settings), stored_state)
3402
pickle.dump((clients, client_settings), stored_state,
3403
protocol=2)
2864
3404
tempname = stored_state.name
2865
3405
os.rename(tempname, stored_state_path)
2866
3406
except (IOError, OSError) as e:
2876
3416
logger.warning("Could not save persistent state:",
2877
3417
exc_info=e)
2878
3418
raise
2879
3419
2880
3420
# Delete all clients, and settings from config
2881
3421
while tcp_server.clients:
2882
3422
name, client = tcp_server.clients.popitem()
2883
3423
if use_dbus:
2884
3424
client.remove_from_connection()
2885
# Don't signal anything except ClientRemoved
3425
# Don't signal the disabling
2886
3426
client.disable(quiet=True)
3427
# Emit D-Bus signal for removal
2887
3428
if use_dbus:
2888
# Emit D-Bus signal
2889
mandos_dbus_service.ClientRemoved(
2890
client.dbus_object_path, client.name)
3429
mandos_dbus_service.client_removed_signal(client)
2891
3430
client_settings.clear()
2892
3431
2893
3432
atexit.register(cleanup)
2894
2895
for client in tcp_server.clients.itervalues():
3433
3434
for client in tcp_server.clients.values():
2896
3435
if use_dbus:
2897
# Emit D-Bus signal
2898
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3436
# Emit D-Bus signal for adding
3437
mandos_dbus_service.client_added_signal(client)
2899
3438
# Need to initiate checking of clients
2900
3439
if client.enabled:
2901
3440
client.init_checker()
2902
3441
2903
3442
tcp_server.enable()
2904
3443
tcp_server.server_activate()
2905
3444
2906
3445
# Find out what port we got
2907
3446
if zeroconf:
2908
3447
service.port = tcp_server.socket.getsockname()[1]
2913
3452
else: # IPv4
2914
3453
logger.info("Now listening on address %r, port %d",
2915
3454
*tcp_server.socket.getsockname())
2916
2917
#service.interface = tcp_server.socket.getsockname()[3]
2918
3455
3456
# service.interface = tcp_server.socket.getsockname()[3]
3457
2919
3458
try:
2920
3459
if zeroconf:
2921
3460
# From the Avahi example code
2926
3465
cleanup()
2927
3466
sys.exit(1)
2928
3467
# End of Avahi example code
2929
2930
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2931
lambda *args, **kwargs:
2932
(tcp_server.handle_request
2933
(*args[2:], **kwargs) or True))
2934
3468
3469
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3470
lambda *args, **kwargs:
3471
(tcp_server.handle_request
3472
(*args[2:], **kwargs) or True))
3473
2935
3474
logger.debug("Starting main loop")
2936
3475
main_loop.run()
2937
3476
except AvahiError as error:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0