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