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