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