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