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