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