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