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