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