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