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