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