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 1234
- compare with another revision
- download diff
- download tarball
- view history from revision 1234
- Committer: Teddy Hogeborn
- Date: 2021-02-03 08:33:43 UTC
- Revision ID: teddy@recompile.se-20210203083343-spdbhxgd5v8e3lv9
Update copyright year
* debian/copyright: Update copyright year to 2021.
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: Update copyright year to 2020.
* intro.xml: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: Update copyright year
to 2021.
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -
* debian/copyright: Update copyright year to 2021.
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: Update copyright year to 2020.
* intro.xml: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: Update copyright year
to 2021.
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -
- 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-2020 Teddy Hogeborn
15
# Copyright © 2008-2020 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.13"
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,
528
**kwargs)
421
529
syslogger.setFormatter(logging.Formatter(
422
530
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
423
531
.format(self.name)))
424
532
return ret
425
533
426
534
427
class Client(object):
535
# Pretend that we have a GnuTLS module
536
class gnutls:
537
"""This isn't so much a class as it is a module-like namespace."""
538
539
library = ctypes.util.find_library("gnutls")
540
if library is None:
541
library = ctypes.util.find_library("gnutls-deb0")
542
_library = ctypes.cdll.LoadLibrary(library)
543
del library
544
545
# Unless otherwise indicated, the constants and types below are
546
# all from the gnutls/gnutls.h C header file.
547
548
# Constants
549
E_SUCCESS = 0
550
E_INTERRUPTED = -52
551
E_AGAIN = -28
552
CRT_OPENPGP = 2
553
CRT_RAWPK = 3
554
CLIENT = 2
555
SHUT_RDWR = 0
556
CRD_CERTIFICATE = 1
557
E_NO_CERTIFICATE_FOUND = -49
558
X509_FMT_DER = 0
559
NO_TICKETS = 1<<10
560
ENABLE_RAWPK = 1<<18
561
CTYPE_PEERS = 3
562
KEYID_USE_SHA256 = 1 # gnutls/x509.h
563
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
564
565
# Types
566
class session_int(ctypes.Structure):
567
_fields_ = []
568
session_t = ctypes.POINTER(session_int)
569
570
class certificate_credentials_st(ctypes.Structure):
571
_fields_ = []
572
certificate_credentials_t = ctypes.POINTER(
573
certificate_credentials_st)
574
certificate_type_t = ctypes.c_int
575
576
class datum_t(ctypes.Structure):
577
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
578
('size', ctypes.c_uint)]
579
580
class openpgp_crt_int(ctypes.Structure):
581
_fields_ = []
582
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
583
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
584
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
585
credentials_type_t = ctypes.c_int
586
transport_ptr_t = ctypes.c_void_p
587
close_request_t = ctypes.c_int
588
589
# Exceptions
590
class Error(Exception):
591
def __init__(self, message=None, code=None, args=()):
592
# Default usage is by a message string, but if a return
593
# code is passed, convert it to a string with
594
# gnutls.strerror()
595
self.code = code
596
if message is None and code is not None:
597
message = gnutls.strerror(code)
598
return super(gnutls.Error, self).__init__(
599
message, *args)
600
601
class CertificateSecurityError(Error):
602
pass
603
604
# Classes
605
class Credentials:
606
def __init__(self):
607
self._c_object = gnutls.certificate_credentials_t()
608
gnutls.certificate_allocate_credentials(
609
ctypes.byref(self._c_object))
610
self.type = gnutls.CRD_CERTIFICATE
611
612
def __del__(self):
613
gnutls.certificate_free_credentials(self._c_object)
614
615
class ClientSession:
616
def __init__(self, socket, credentials=None):
617
self._c_object = gnutls.session_t()
618
gnutls_flags = gnutls.CLIENT
619
if gnutls.check_version(b"3.5.6"):
620
gnutls_flags |= gnutls.NO_TICKETS
621
if gnutls.has_rawpk:
622
gnutls_flags |= gnutls.ENABLE_RAWPK
623
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
624
del gnutls_flags
625
gnutls.set_default_priority(self._c_object)
626
gnutls.transport_set_ptr(self._c_object, socket.fileno())
627
gnutls.handshake_set_private_extensions(self._c_object,
628
True)
629
self.socket = socket
630
if credentials is None:
631
credentials = gnutls.Credentials()
632
gnutls.credentials_set(self._c_object, credentials.type,
633
ctypes.cast(credentials._c_object,
634
ctypes.c_void_p))
635
self.credentials = credentials
636
637
def __del__(self):
638
gnutls.deinit(self._c_object)
639
640
def handshake(self):
641
return gnutls.handshake(self._c_object)
642
643
def send(self, data):
644
data = bytes(data)
645
data_len = len(data)
646
while data_len > 0:
647
data_len -= gnutls.record_send(self._c_object,
648
data[-data_len:],
649
data_len)
650
651
def bye(self):
652
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
653
654
# Error handling functions
655
def _error_code(result):
656
"""A function to raise exceptions on errors, suitable
657
for the 'restype' attribute on ctypes functions"""
658
if result >= 0:
659
return result
660
if result == gnutls.E_NO_CERTIFICATE_FOUND:
661
raise gnutls.CertificateSecurityError(code=result)
662
raise gnutls.Error(code=result)
663
664
def _retry_on_error(result, func, arguments):
665
"""A function to retry on some errors, suitable
666
for the 'errcheck' attribute on ctypes functions"""
667
while result < 0:
668
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
669
return _error_code(result)
670
result = func(*arguments)
671
return result
672
673
# Unless otherwise indicated, the function declarations below are
674
# all from the gnutls/gnutls.h C header file.
675
676
# Functions
677
priority_set_direct = _library.gnutls_priority_set_direct
678
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
679
ctypes.POINTER(ctypes.c_char_p)]
680
priority_set_direct.restype = _error_code
681
682
init = _library.gnutls_init
683
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
684
init.restype = _error_code
685
686
set_default_priority = _library.gnutls_set_default_priority
687
set_default_priority.argtypes = [session_t]
688
set_default_priority.restype = _error_code
689
690
record_send = _library.gnutls_record_send
691
record_send.argtypes = [session_t, ctypes.c_void_p,
692
ctypes.c_size_t]
693
record_send.restype = ctypes.c_ssize_t
694
record_send.errcheck = _retry_on_error
695
696
certificate_allocate_credentials = (
697
_library.gnutls_certificate_allocate_credentials)
698
certificate_allocate_credentials.argtypes = [
699
ctypes.POINTER(certificate_credentials_t)]
700
certificate_allocate_credentials.restype = _error_code
701
702
certificate_free_credentials = (
703
_library.gnutls_certificate_free_credentials)
704
certificate_free_credentials.argtypes = [
705
certificate_credentials_t]
706
certificate_free_credentials.restype = None
707
708
handshake_set_private_extensions = (
709
_library.gnutls_handshake_set_private_extensions)
710
handshake_set_private_extensions.argtypes = [session_t,
711
ctypes.c_int]
712
handshake_set_private_extensions.restype = None
713
714
credentials_set = _library.gnutls_credentials_set
715
credentials_set.argtypes = [session_t, credentials_type_t,
716
ctypes.c_void_p]
717
credentials_set.restype = _error_code
718
719
strerror = _library.gnutls_strerror
720
strerror.argtypes = [ctypes.c_int]
721
strerror.restype = ctypes.c_char_p
722
723
certificate_type_get = _library.gnutls_certificate_type_get
724
certificate_type_get.argtypes = [session_t]
725
certificate_type_get.restype = _error_code
726
727
certificate_get_peers = _library.gnutls_certificate_get_peers
728
certificate_get_peers.argtypes = [session_t,
729
ctypes.POINTER(ctypes.c_uint)]
730
certificate_get_peers.restype = ctypes.POINTER(datum_t)
731
732
global_set_log_level = _library.gnutls_global_set_log_level
733
global_set_log_level.argtypes = [ctypes.c_int]
734
global_set_log_level.restype = None
735
736
global_set_log_function = _library.gnutls_global_set_log_function
737
global_set_log_function.argtypes = [log_func]
738
global_set_log_function.restype = None
739
740
deinit = _library.gnutls_deinit
741
deinit.argtypes = [session_t]
742
deinit.restype = None
743
744
handshake = _library.gnutls_handshake
745
handshake.argtypes = [session_t]
746
handshake.restype = _error_code
747
handshake.errcheck = _retry_on_error
748
749
transport_set_ptr = _library.gnutls_transport_set_ptr
750
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
751
transport_set_ptr.restype = None
752
753
bye = _library.gnutls_bye
754
bye.argtypes = [session_t, close_request_t]
755
bye.restype = _error_code
756
bye.errcheck = _retry_on_error
757
758
check_version = _library.gnutls_check_version
759
check_version.argtypes = [ctypes.c_char_p]
760
check_version.restype = ctypes.c_char_p
761
762
_need_version = b"3.3.0"
763
if check_version(_need_version) is None:
764
raise self.Error("Needs GnuTLS {} or later"
765
.format(_need_version))
766
767
_tls_rawpk_version = b"3.6.6"
768
has_rawpk = bool(check_version(_tls_rawpk_version))
769
770
if has_rawpk:
771
# Types
772
class pubkey_st(ctypes.Structure):
773
_fields = []
774
pubkey_t = ctypes.POINTER(pubkey_st)
775
776
x509_crt_fmt_t = ctypes.c_int
777
778
# All the function declarations below are from
779
# gnutls/abstract.h
780
pubkey_init = _library.gnutls_pubkey_init
781
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
782
pubkey_init.restype = _error_code
783
784
pubkey_import = _library.gnutls_pubkey_import
785
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
786
x509_crt_fmt_t]
787
pubkey_import.restype = _error_code
788
789
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
790
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
791
ctypes.POINTER(ctypes.c_ubyte),
792
ctypes.POINTER(ctypes.c_size_t)]
793
pubkey_get_key_id.restype = _error_code
794
795
pubkey_deinit = _library.gnutls_pubkey_deinit
796
pubkey_deinit.argtypes = [pubkey_t]
797
pubkey_deinit.restype = None
798
else:
799
# All the function declarations below are from
800
# gnutls/openpgp.h
801
802
openpgp_crt_init = _library.gnutls_openpgp_crt_init
803
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
804
openpgp_crt_init.restype = _error_code
805
806
openpgp_crt_import = _library.gnutls_openpgp_crt_import
807
openpgp_crt_import.argtypes = [openpgp_crt_t,
808
ctypes.POINTER(datum_t),
809
openpgp_crt_fmt_t]
810
openpgp_crt_import.restype = _error_code
811
812
openpgp_crt_verify_self = \
813
_library.gnutls_openpgp_crt_verify_self
814
openpgp_crt_verify_self.argtypes = [
815
openpgp_crt_t,
816
ctypes.c_uint,
817
ctypes.POINTER(ctypes.c_uint),
818
]
819
openpgp_crt_verify_self.restype = _error_code
820
821
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
822
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
823
openpgp_crt_deinit.restype = None
824
825
openpgp_crt_get_fingerprint = (
826
_library.gnutls_openpgp_crt_get_fingerprint)
827
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
828
ctypes.c_void_p,
829
ctypes.POINTER(
830
ctypes.c_size_t)]
831
openpgp_crt_get_fingerprint.restype = _error_code
832
833
if check_version(b"3.6.4"):
834
certificate_type_get2 = _library.gnutls_certificate_type_get2
835
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
836
certificate_type_get2.restype = _error_code
837
838
# Remove non-public functions
839
del _error_code, _retry_on_error
840
841
842
def call_pipe(connection, # : multiprocessing.Connection
843
func, *args, **kwargs):
844
"""This function is meant to be called by multiprocessing.Process
845
846
This function runs func(*args, **kwargs), and writes the resulting
847
return value on the provided multiprocessing.Connection.
848
"""
849
connection.send(func(*args, **kwargs))
850
connection.close()
851
852
853
class Client:
428
854
"""A representation of a client host served by this server.
429
855
430
856
Attributes:
431
857
approved: bool(); 'None' if not yet approved/disapproved
432
858
approval_delay: datetime.timedelta(); Time to wait for approval
433
859
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
860
checker: multiprocessing.Process(); a running checker process used
861
to see if the client lives. 'None' if no process is
862
running.
863
checker_callback_tag: a GLib event source tag, or None
438
864
checker_command: string; External command which is run to check
439
865
if client lives. %() expansions are done at
440
866
runtime with vars(self) as dict, so that for
441
867
instance %(name)s can be used in the command.
442
checker_initiator_tag: a gobject event source tag, or None
868
checker_initiator_tag: a GLib event source tag, or None
443
869
created: datetime.datetime(); (UTC) object creation
444
870
client_structure: Object describing what attributes a client has
445
871
and is used for storing the client at exit
446
872
current_checker_command: string; current running checker_command
447
disable_initiator_tag: a gobject event source tag, or None
873
disable_initiator_tag: a GLib event source tag, or None
448
874
enabled: bool()
449
875
fingerprint: string (40 or 32 hexadecimal digits); used to
450
uniquely identify the client
876
uniquely identify an OpenPGP client
877
key_id: string (64 hexadecimal digits); used to uniquely identify
878
a client using raw public keys
451
879
host: string; available for use by the checker command
452
880
interval: datetime.timedelta(); How often to start a new checker
453
881
last_approval_request: datetime.datetime(); (UTC) or None
455
883
last_checker_status: integer between 0 and 255 reflecting exit
456
884
status of last checker. -1 reflects crashed
457
885
checker, -2 means no checker completed yet.
886
last_checker_signal: The signal which killed the last checker, if
887
last_checker_status is -1
458
888
last_enabled: datetime.datetime(); (UTC) or None
459
889
name: string; from the config file, used in log messages and
460
890
D-Bus identifiers
467
897
disabled, or None
468
898
server_settings: The server_settings dict from main()
469
899
"""
470
900
471
901
runtime_expansions = ("approval_delay", "approval_duration",
472
"created", "enabled", "expires",
902
"created", "enabled", "expires", "key_id",
473
903
"fingerprint", "host", "interval",
474
904
"last_approval_request", "last_checked_ok",
475
905
"last_enabled", "name", "timeout")
484
914
"approved_by_default": "True",
485
915
"enabled": "True",
486
916
}
487
917
488
918
@staticmethod
489
919
def config_parser(config):
490
920
"""Construct a new dict of client settings of this form:
497
927
for client_name in config.sections():
498
928
section = dict(config.items(client_name))
499
929
client = settings[client_name] = {}
500
930
501
931
client["host"] = section["host"]
502
932
# Reformat values from string types to Python types
503
933
client["approved_by_default"] = config.getboolean(
504
934
client_name, "approved_by_default")
505
935
client["enabled"] = config.getboolean(client_name,
506
936
"enabled")
507
508
# Uppercase and remove spaces from fingerprint for later
509
# comparison purposes with return value from the
510
# fingerprint() function
937
938
# Uppercase and remove spaces from key_id and fingerprint
939
# for later comparison purposes with return value from the
940
# key_id() and fingerprint() functions
941
client["key_id"] = (section.get("key_id", "").upper()
942
.replace(" ", ""))
511
943
client["fingerprint"] = (section["fingerprint"].upper()
512
944
.replace(" ", ""))
513
945
if "secret" in section:
514
client["secret"] = section["secret"].decode("base64")
946
client["secret"] = codecs.decode(section["secret"]
947
.encode("utf-8"),
948
"base64")
515
949
elif "secfile" in section:
516
950
with open(os.path.expanduser(os.path.expandvars
517
951
(section["secfile"])),
532
966
client["last_approval_request"] = None
533
967
client["last_checked_ok"] = None
534
968
client["last_checker_status"] = -2
535
969
536
970
return settings
537
538
def __init__(self, settings, name = None, server_settings=None):
971
972
def __init__(self, settings, name=None, server_settings=None):
539
973
self.name = name
540
974
if server_settings is None:
541
975
server_settings = {}
543
977
# adding all client settings
544
978
for setting, value in settings.items():
545
979
setattr(self, setting, value)
546
980
547
981
if self.enabled:
548
982
if not hasattr(self, "last_enabled"):
549
983
self.last_enabled = datetime.datetime.utcnow()
553
987
else:
554
988
self.last_enabled = None
555
989
self.expires = None
556
990
557
991
logger.debug("Creating client %r", self.name)
992
logger.debug(" Key ID: %s", self.key_id)
558
993
logger.debug(" Fingerprint: %s", self.fingerprint)
559
994
self.created = settings.get("created",
560
995
datetime.datetime.utcnow())
561
996
562
997
# attributes specific for this server instance
563
998
self.checker = None
564
999
self.checker_initiator_tag = None
570
1005
self.changedstate = multiprocessing_manager.Condition(
571
1006
multiprocessing_manager.Lock())
572
1007
self.client_structure = [attr
573
for attr in self.__dict__.iterkeys()
1008
for attr in self.__dict__.keys()
574
1009
if not attr.startswith("_")]
575
1010
self.client_structure.append("client_structure")
576
1011
577
1012
for name, t in inspect.getmembers(
578
1013
type(self), lambda obj: isinstance(obj, property)):
579
1014
if not name.startswith("_"):
580
1015
self.client_structure.append(name)
581
1016
582
1017
# Send notice to process children that client state has changed
583
1018
def send_changedstate(self):
584
1019
with self.changedstate:
585
1020
self.changedstate.notify_all()
586
1021
587
1022
def enable(self):
588
1023
"""Start this client's checker and timeout hooks"""
589
1024
if getattr(self, "enabled", False):
594
1029
self.last_enabled = datetime.datetime.utcnow()
595
1030
self.init_checker()
596
1031
self.send_changedstate()
597
1032
598
1033
def disable(self, quiet=True):
599
1034
"""Disable this client."""
600
1035
if not getattr(self, "enabled", False):
602
1037
if not quiet:
603
1038
logger.info("Disabling client %s", self.name)
604
1039
if getattr(self, "disable_initiator_tag", None) is not None:
605
gobject.source_remove(self.disable_initiator_tag)
1040
GLib.source_remove(self.disable_initiator_tag)
606
1041
self.disable_initiator_tag = None
607
1042
self.expires = None
608
1043
if getattr(self, "checker_initiator_tag", None) is not None:
609
gobject.source_remove(self.checker_initiator_tag)
1044
GLib.source_remove(self.checker_initiator_tag)
610
1045
self.checker_initiator_tag = None
611
1046
self.stop_checker()
612
1047
self.enabled = False
613
1048
if not quiet:
614
1049
self.send_changedstate()
615
# Do not run this again if called by a gobject.timeout_add
1050
# Do not run this again if called by a GLib.timeout_add
616
1051
return False
617
1052
618
1053
def __del__(self):
619
1054
self.disable()
620
1055
621
1056
def init_checker(self):
622
1057
# Schedule a new checker to be started an 'interval' from now,
623
1058
# and every interval from then on.
624
1059
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),
1060
GLib.source_remove(self.checker_initiator_tag)
1061
self.checker_initiator_tag = GLib.timeout_add(
1062
random.randrange(int(self.interval.total_seconds() * 1000
1063
+ 1)),
628
1064
self.start_checker)
629
1065
# Schedule a disable() when 'timeout' has passed
630
1066
if self.disable_initiator_tag is not None:
631
gobject.source_remove(self.disable_initiator_tag)
632
self.disable_initiator_tag = gobject.timeout_add(
1067
GLib.source_remove(self.disable_initiator_tag)
1068
self.disable_initiator_tag = GLib.timeout_add(
633
1069
int(self.timeout.total_seconds() * 1000), self.disable)
634
1070
# Also start a new checker *right now*.
635
1071
self.start_checker()
636
637
def checker_callback(self, pid, condition, command):
1072
1073
def checker_callback(self, source, condition, connection,
1074
command):
638
1075
"""The checker has completed, so take appropriate actions."""
1076
# Read return code from connection (see call_pipe)
1077
returncode = connection.recv()
1078
connection.close()
1079
if self.checker is not None:
1080
self.checker.join()
639
1081
self.checker_callback_tag = None
640
1082
self.checker = None
641
if os.WIFEXITED(condition):
642
self.last_checker_status = os.WEXITSTATUS(condition)
1083
1084
if returncode >= 0:
1085
self.last_checker_status = returncode
1086
self.last_checker_signal = None
643
1087
if self.last_checker_status == 0:
644
1088
logger.info("Checker for %(name)s succeeded",
645
1089
vars(self))
648
1092
logger.info("Checker for %(name)s failed", vars(self))
649
1093
else:
650
1094
self.last_checker_status = -1
1095
self.last_checker_signal = -returncode
651
1096
logger.warning("Checker for %(name)s crashed?",
652
1097
vars(self))
653
1098
return False
1099
654
1100
def checked_ok(self):
655
1101
"""Assert that the client has been seen, alive and well."""
656
1102
self.last_checked_ok = datetime.datetime.utcnow()
657
1103
self.last_checker_status = 0
1104
self.last_checker_signal = None
658
1105
self.bump_timeout()
659
1106
660
1107
def bump_timeout(self, timeout=None):
661
1108
"""Bump up the timeout for this client."""
662
1109
if timeout is None:
663
1110
timeout = self.timeout
664
1111
if self.disable_initiator_tag is not None:
665
gobject.source_remove(self.disable_initiator_tag)
1112
GLib.source_remove(self.disable_initiator_tag)
666
1113
self.disable_initiator_tag = None
667
1114
if getattr(self, "enabled", False):
668
self.disable_initiator_tag = gobject.timeout_add(
1115
self.disable_initiator_tag = GLib.timeout_add(
669
1116
int(timeout.total_seconds() * 1000), self.disable)
670
1117
self.expires = datetime.datetime.utcnow() + timeout
671
1118
672
1119
def need_approval(self):
673
1120
self.last_approval_request = datetime.datetime.utcnow()
674
1121
675
1122
def start_checker(self):
676
1123
"""Start a new checker subprocess if one is not running.
677
1124
678
1125
If a checker already exists, leave it running and do
679
1126
nothing."""
680
1127
# The reason for not killing a running checker is that if we
685
1132
# checkers alone, the checker would have to take more time
686
1133
# than 'timeout' for the client to be disabled, which is as it
687
1134
# 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)
1135
1136
if self.checker is not None and not self.checker.is_alive():
1137
logger.warning("Checker was not alive; joining")
1138
self.checker.join()
1139
self.checker = None
703
1140
# Start a new checker if needed
704
1141
if self.checker is None:
705
1142
# Escape attributes for the shell
706
1143
escaped_attrs = {
707
attr: re.escape(str(getattr(self, attr)))
708
for attr in self.runtime_expansions }
1144
attr: shlex.quote(str(getattr(self, attr)))
1145
for attr in self.runtime_expansions}
709
1146
try:
710
1147
command = self.checker_command % escaped_attrs
711
1148
except TypeError as error:
714
1151
exc_info=error)
715
1152
return True # Try again later
716
1153
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
1154
logger.info("Starting checker %r for %s", command,
1155
self.name)
1156
# We don't need to redirect stdout and stderr, since
1157
# in normal mode, that is already done by daemon(),
1158
# and in debug mode we don't want to. (Stdin is
1159
# always replaced by /dev/null.)
1160
# The exception is when not debugging but nevertheless
1161
# running in the foreground; use the previously
1162
# created wnull.
1163
popen_args = {"close_fds": True,
1164
"shell": True,
1165
"cwd": "/"}
1166
if (not self.server_settings["debug"]
1167
and self.server_settings["foreground"]):
1168
popen_args.update({"stdout": wnull,
1169
"stderr": wnull})
1170
pipe = multiprocessing.Pipe(duplex=False)
1171
self.checker = multiprocessing.Process(
1172
target=call_pipe,
1173
args=(pipe[1], subprocess.call, command),
1174
kwargs=popen_args)
1175
self.checker.start()
1176
self.checker_callback_tag = GLib.io_add_watch(
1177
GLib.IOChannel.unix_new(pipe[0].fileno()),
1178
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1179
self.checker_callback, pipe[0], command)
1180
# Re-run this periodically if run by GLib.timeout_add
758
1181
return True
759
1182
760
1183
def stop_checker(self):
761
1184
"""Force the checker process, if any, to stop."""
762
1185
if self.checker_callback_tag:
763
gobject.source_remove(self.checker_callback_tag)
1186
GLib.source_remove(self.checker_callback_tag)
764
1187
self.checker_callback_tag = None
765
1188
if getattr(self, "checker", None) is None:
766
1189
return
767
1190
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
1191
self.checker.terminate()
776
1192
self.checker = None
777
1193
778
1194
782
1198
byte_arrays=False):
783
1199
"""Decorators for marking methods of a DBusObjectWithProperties to
784
1200
become properties on the D-Bus.
785
1201
786
1202
The decorated method will be called with no arguments by "Get"
787
1203
and with one argument by "Set".
788
1204
789
1205
The parameters, where they are supported, are the same as
790
1206
dbus.service.method, except there is only "signature", since the
791
1207
type from Get() and the type sent to Set() is the same.
795
1211
if byte_arrays and signature != "ay":
796
1212
raise ValueError("Byte arrays not supported for non-'ay'"
797
1213
" signature {!r}".format(signature))
798
1214
799
1215
def decorator(func):
800
1216
func._dbus_is_property = True
801
1217
func._dbus_interface = dbus_interface
804
1220
func._dbus_name = func.__name__
805
1221
if func._dbus_name.endswith("_dbus_property"):
806
1222
func._dbus_name = func._dbus_name[:-14]
807
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1223
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
808
1224
return func
809
1225
810
1226
return decorator
811
1227
812
1228
813
1229
def dbus_interface_annotations(dbus_interface):
814
1230
"""Decorator for marking functions returning interface annotations
815
1231
816
1232
Usage:
817
1233
818
1234
@dbus_interface_annotations("org.example.Interface")
819
1235
def _foo(self): # Function name does not matter
820
1236
return {"org.freedesktop.DBus.Deprecated": "true",
821
1237
"org.freedesktop.DBus.Property.EmitsChangedSignal":
822
1238
"false"}
823
1239
"""
824
1240
825
1241
def decorator(func):
826
1242
func._dbus_is_interface = True
827
1243
func._dbus_interface = dbus_interface
828
1244
func._dbus_name = dbus_interface
829
1245
return func
830
1246
831
1247
return decorator
832
1248
833
1249
834
1250
def dbus_annotations(annotations):
835
1251
"""Decorator to annotate D-Bus methods, signals or properties
836
1252
Usage:
837
1253
838
1254
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
839
1255
"org.freedesktop.DBus.Property."
840
1256
"EmitsChangedSignal": "false"})
842
1258
access="r")
843
1259
def Property_dbus_property(self):
844
1260
return dbus.Boolean(False)
1261
1262
See also the DBusObjectWithAnnotations class.
845
1263
"""
846
1264
847
1265
def decorator(func):
848
1266
func._dbus_annotations = annotations
849
1267
return func
850
1268
851
1269
return decorator
852
1270
853
1271
869
1287
pass
870
1288
871
1289
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.
1290
class DBusObjectWithAnnotations(dbus.service.Object):
1291
"""A D-Bus object with annotations.
1292
1293
Classes inheriting from this can use the dbus_annotations
1294
decorator to add annotations to methods or signals.
878
1295
"""
879
1296
880
1297
@staticmethod
881
1298
def _is_dbus_thing(thing):
882
1299
"""Returns a function testing if an attribute is a D-Bus thing
883
1300
884
1301
If called like _is_dbus_thing("method") it returns a function
885
1302
suitable for use as predicate to inspect.getmembers().
886
1303
"""
887
1304
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
888
1305
False)
889
1306
890
1307
def _get_all_dbus_things(self, thing):
891
1308
"""Returns a generator of (name, attribute) pairs
892
1309
"""
895
1312
for cls in self.__class__.__mro__
896
1313
for name, athing in
897
1314
inspect.getmembers(cls, self._is_dbus_thing(thing)))
898
1315
1316
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1317
out_signature="s",
1318
path_keyword='object_path',
1319
connection_keyword='connection')
1320
def Introspect(self, object_path, connection):
1321
"""Overloading of standard D-Bus method.
1322
1323
Inserts annotation tags on methods and signals.
1324
"""
1325
xmlstring = dbus.service.Object.Introspect(self, object_path,
1326
connection)
1327
try:
1328
document = xml.dom.minidom.parseString(xmlstring)
1329
1330
for if_tag in document.getElementsByTagName("interface"):
1331
# Add annotation tags
1332
for typ in ("method", "signal"):
1333
for tag in if_tag.getElementsByTagName(typ):
1334
annots = dict()
1335
for name, prop in (self.
1336
_get_all_dbus_things(typ)):
1337
if (name == tag.getAttribute("name")
1338
and prop._dbus_interface
1339
== if_tag.getAttribute("name")):
1340
annots.update(getattr(
1341
prop, "_dbus_annotations", {}))
1342
for name, value in annots.items():
1343
ann_tag = document.createElement(
1344
"annotation")
1345
ann_tag.setAttribute("name", name)
1346
ann_tag.setAttribute("value", value)
1347
tag.appendChild(ann_tag)
1348
# Add interface annotation tags
1349
for annotation, value in dict(
1350
itertools.chain.from_iterable(
1351
annotations().items()
1352
for name, annotations
1353
in self._get_all_dbus_things("interface")
1354
if name == if_tag.getAttribute("name")
1355
)).items():
1356
ann_tag = document.createElement("annotation")
1357
ann_tag.setAttribute("name", annotation)
1358
ann_tag.setAttribute("value", value)
1359
if_tag.appendChild(ann_tag)
1360
# Fix argument name for the Introspect method itself
1361
if (if_tag.getAttribute("name")
1362
== dbus.INTROSPECTABLE_IFACE):
1363
for cn in if_tag.getElementsByTagName("method"):
1364
if cn.getAttribute("name") == "Introspect":
1365
for arg in cn.getElementsByTagName("arg"):
1366
if (arg.getAttribute("direction")
1367
== "out"):
1368
arg.setAttribute("name",
1369
"xml_data")
1370
xmlstring = document.toxml("utf-8")
1371
document.unlink()
1372
except (AttributeError, xml.dom.DOMException,
1373
xml.parsers.expat.ExpatError) as error:
1374
logger.error("Failed to override Introspection method",
1375
exc_info=error)
1376
return xmlstring
1377
1378
1379
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1380
"""A D-Bus object with properties.
1381
1382
Classes inheriting from this can use the dbus_service_property
1383
decorator to expose methods as D-Bus properties. It exposes the
1384
standard Get(), Set(), and GetAll() methods on the D-Bus.
1385
"""
1386
899
1387
def _get_dbus_property(self, interface_name, property_name):
900
1388
"""Returns a bound method if one exists which is a D-Bus
901
1389
property with the specified name and interface.
906
1394
if (value._dbus_name == property_name
907
1395
and value._dbus_interface == interface_name):
908
1396
return value.__get__(self)
909
1397
910
1398
# No such property
911
1399
raise DBusPropertyNotFound("{}:{}.{}".format(
912
1400
self.dbus_object_path, interface_name, property_name))
913
1401
1402
@classmethod
1403
def _get_all_interface_names(cls):
1404
"""Get a sequence of all interfaces supported by an object"""
1405
return (name for name in set(getattr(getattr(x, attr),
1406
"_dbus_interface", None)
1407
for x in (inspect.getmro(cls))
1408
for attr in dir(x))
1409
if name is not None)
1410
914
1411
@dbus.service.method(dbus.PROPERTIES_IFACE,
915
1412
in_signature="ss",
916
1413
out_signature="v")
924
1421
if not hasattr(value, "variant_level"):
925
1422
return value
926
1423
return type(value)(value, variant_level=value.variant_level+1)
927
1424
928
1425
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
929
1426
def Set(self, interface_name, property_name, value):
930
1427
"""Standard D-Bus property Set() method, see D-Bus standard.
939
1436
raise ValueError("Byte arrays not supported for non-"
940
1437
"'ay' signature {!r}"
941
1438
.format(prop._dbus_signature))
942
value = dbus.ByteArray(b''.join(chr(byte)
943
for byte in value))
1439
value = dbus.ByteArray(bytes(value))
944
1440
prop(value)
945
1441
946
1442
@dbus.service.method(dbus.PROPERTIES_IFACE,
947
1443
in_signature="s",
948
1444
out_signature="a{sv}")
949
1445
def GetAll(self, interface_name):
950
1446
"""Standard D-Bus property GetAll() method, see D-Bus
951
1447
standard.
952
1448
953
1449
Note: Will not include properties with access="write".
954
1450
"""
955
1451
properties = {}
966
1462
properties[name] = value
967
1463
continue
968
1464
properties[name] = type(value)(
969
value, variant_level = value.variant_level + 1)
1465
value, variant_level=value.variant_level + 1)
970
1466
return dbus.Dictionary(properties, signature="sv")
971
1467
972
1468
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
973
1469
def PropertiesChanged(self, interface_name, changed_properties,
974
1470
invalidated_properties):
976
1472
standard.
977
1473
"""
978
1474
pass
979
1475
980
1476
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
981
1477
out_signature="s",
982
1478
path_keyword='object_path',
983
1479
connection_keyword='connection')
984
1480
def Introspect(self, object_path, connection):
985
1481
"""Overloading of standard D-Bus method.
986
1482
987
1483
Inserts property tags and interface annotation tags.
988
1484
"""
989
xmlstring = dbus.service.Object.Introspect(self, object_path,
990
connection)
1485
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1486
object_path,
1487
connection)
991
1488
try:
992
1489
document = xml.dom.minidom.parseString(xmlstring)
993
1490
994
1491
def make_tag(document, name, prop):
995
1492
e = document.createElement("property")
996
1493
e.setAttribute("name", name)
997
1494
e.setAttribute("type", prop._dbus_signature)
998
1495
e.setAttribute("access", prop._dbus_access)
999
1496
return e
1000
1497
1001
1498
for if_tag in document.getElementsByTagName("interface"):
1002
1499
# Add property tags
1003
1500
for tag in (make_tag(document, name, prop)
1006
1503
if prop._dbus_interface
1007
1504
== if_tag.getAttribute("name")):
1008
1505
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)
1506
# Add annotation tags for properties
1507
for tag in if_tag.getElementsByTagName("property"):
1508
annots = dict()
1509
for name, prop in self._get_all_dbus_things(
1510
"property"):
1511
if (name == tag.getAttribute("name")
1512
and prop._dbus_interface
1513
== if_tag.getAttribute("name")):
1514
annots.update(getattr(
1515
prop, "_dbus_annotations", {}))
1516
for name, value in annots.items():
1517
ann_tag = document.createElement(
1518
"annotation")
1519
ann_tag.setAttribute("name", name)
1520
ann_tag.setAttribute("value", value)
1521
tag.appendChild(ann_tag)
1038
1522
# Add the names to the return values for the
1039
1523
# "org.freedesktop.DBus.Properties" methods
1040
1524
if (if_tag.getAttribute("name")
1059
1543
return xmlstring
1060
1544
1061
1545
1546
try:
1547
dbus.OBJECT_MANAGER_IFACE
1548
except AttributeError:
1549
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1550
1551
1552
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1553
"""A D-Bus object with an ObjectManager.
1554
1555
Classes inheriting from this exposes the standard
1556
GetManagedObjects call and the InterfacesAdded and
1557
InterfacesRemoved signals on the standard
1558
"org.freedesktop.DBus.ObjectManager" interface.
1559
1560
Note: No signals are sent automatically; they must be sent
1561
manually.
1562
"""
1563
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1564
out_signature="a{oa{sa{sv}}}")
1565
def GetManagedObjects(self):
1566
"""This function must be overridden"""
1567
raise NotImplementedError()
1568
1569
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1570
signature="oa{sa{sv}}")
1571
def InterfacesAdded(self, object_path, interfaces_and_properties):
1572
pass
1573
1574
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1575
def InterfacesRemoved(self, object_path, interfaces):
1576
pass
1577
1578
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1579
out_signature="s",
1580
path_keyword='object_path',
1581
connection_keyword='connection')
1582
def Introspect(self, object_path, connection):
1583
"""Overloading of standard D-Bus method.
1584
1585
Override return argument name of GetManagedObjects to be
1586
"objpath_interfaces_and_properties"
1587
"""
1588
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1589
object_path,
1590
connection)
1591
try:
1592
document = xml.dom.minidom.parseString(xmlstring)
1593
1594
for if_tag in document.getElementsByTagName("interface"):
1595
# Fix argument name for the GetManagedObjects method
1596
if (if_tag.getAttribute("name")
1597
== dbus.OBJECT_MANAGER_IFACE):
1598
for cn in if_tag.getElementsByTagName("method"):
1599
if (cn.getAttribute("name")
1600
== "GetManagedObjects"):
1601
for arg in cn.getElementsByTagName("arg"):
1602
if (arg.getAttribute("direction")
1603
== "out"):
1604
arg.setAttribute(
1605
"name",
1606
"objpath_interfaces"
1607
"_and_properties")
1608
xmlstring = document.toxml("utf-8")
1609
document.unlink()
1610
except (AttributeError, xml.dom.DOMException,
1611
xml.parsers.expat.ExpatError) as error:
1612
logger.error("Failed to override Introspection method",
1613
exc_info=error)
1614
return xmlstring
1615
1616
1062
1617
def datetime_to_dbus(dt, variant_level=0):
1063
1618
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1064
1619
if dt is None:
1065
return dbus.String("", variant_level = variant_level)
1620
return dbus.String("", variant_level=variant_level)
1066
1621
return dbus.String(dt.isoformat(), variant_level=variant_level)
1067
1622
1068
1623
1071
1626
dbus.service.Object, it will add alternate D-Bus attributes with
1072
1627
interface names according to the "alt_interface_names" mapping.
1073
1628
Usage:
1074
1629
1075
1630
@alternate_dbus_interfaces({"org.example.Interface":
1076
1631
"net.example.AlternateInterface"})
1077
1632
class SampleDBusObject(dbus.service.Object):
1078
1633
@dbus.service.method("org.example.Interface")
1079
1634
def SampleDBusMethod():
1080
1635
pass
1081
1636
1082
1637
The above "SampleDBusMethod" on "SampleDBusObject" will be
1083
1638
reachable via two interfaces: "org.example.Interface" and
1084
1639
"net.example.AlternateInterface", the latter of which will have
1085
1640
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1086
1641
"true", unless "deprecate" is passed with a False value.
1087
1642
1088
1643
This works for methods and signals, and also for D-Bus properties
1089
1644
(from DBusObjectWithProperties) and interfaces (from the
1090
1645
dbus_interface_annotations decorator).
1091
1646
"""
1092
1647
1093
1648
def wrapper(cls):
1094
1649
for orig_interface_name, alt_interface_name in (
1095
1650
alt_interface_names.items()):
1112
1667
if getattr(attribute, "_dbus_is_signal", False):
1113
1668
# Extract the original non-method undecorated
1114
1669
# function by black magic
1115
nonmethod_func = (dict(
1116
zip(attribute.func_code.co_freevars,
1117
attribute.__closure__))
1118
["func"].cell_contents)
1670
if sys.version_info.major == 2:
1671
nonmethod_func = (dict(
1672
zip(attribute.func_code.co_freevars,
1673
attribute.__closure__))
1674
["func"].cell_contents)
1675
else:
1676
nonmethod_func = (dict(
1677
zip(attribute.__code__.co_freevars,
1678
attribute.__closure__))
1679
["func"].cell_contents)
1119
1680
# Create a new, but exactly alike, function
1120
1681
# object, and decorate it to be a new D-Bus signal
1121
1682
# with the alternate D-Bus interface name
1683
new_function = copy_function(nonmethod_func)
1122
1684
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)))
1685
alt_interface,
1686
attribute._dbus_signature)(new_function))
1130
1687
# Copy annotations, if any
1131
1688
try:
1132
1689
new_function._dbus_annotations = dict(
1133
1690
attribute._dbus_annotations)
1134
1691
except AttributeError:
1135
1692
pass
1693
1136
1694
# Define a creator of a function to call both the
1137
1695
# original and alternate functions, so both the
1138
1696
# original and alternate signals gets sent when
1141
1699
"""This function is a scope container to pass
1142
1700
func1 and func2 to the "call_both" function
1143
1701
outside of its arguments"""
1144
1702
1703
@functools.wraps(func2)
1145
1704
def call_both(*args, **kwargs):
1146
1705
"""This function will emit two D-Bus
1147
1706
signals by calling func1 and func2"""
1148
1707
func1(*args, **kwargs)
1149
1708
func2(*args, **kwargs)
1150
1709
# Make wrapper function look like a D-Bus
1710
# signal
1711
for name, attr in inspect.getmembers(func2):
1712
if name.startswith("_dbus_"):
1713
setattr(call_both, name, attr)
1714
1151
1715
return call_both
1152
1716
# Create the "call_both" function and add it to
1153
1717
# the class
1163
1727
alt_interface,
1164
1728
attribute._dbus_in_signature,
1165
1729
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)))
1730
(copy_function(attribute)))
1171
1731
# Copy annotations, if any
1172
1732
try:
1173
1733
attr[attrname]._dbus_annotations = dict(
1185
1745
attribute._dbus_access,
1186
1746
attribute._dbus_get_args_options
1187
1747
["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)))
1748
(copy_function(attribute)))
1194
1749
# Copy annotations, if any
1195
1750
try:
1196
1751
attr[attrname]._dbus_annotations = dict(
1205
1760
# to the class.
1206
1761
attr[attrname] = (
1207
1762
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)))
1763
(copy_function(attribute)))
1213
1764
if deprecate:
1214
1765
# Deprecate all alternate interfaces
1215
iname="_AlternateDBusNames_interface_annotation{}"
1766
iname = "_AlternateDBusNames_interface_annotation{}"
1216
1767
for interface_name in interface_names:
1217
1768
1218
1769
@dbus_interface_annotations(interface_name)
1219
1770
def func(self):
1220
return { "org.freedesktop.DBus.Deprecated":
1221
"true" }
1771
return {"org.freedesktop.DBus.Deprecated":
1772
"true"}
1222
1773
# Find an unused name
1223
1774
for aname in (iname.format(i)
1224
1775
for i in itertools.count()):
1228
1779
if interface_names:
1229
1780
# Replace the class with a new subclass of it with
1230
1781
# methods, signals, etc. as created above.
1231
cls = type(b"{}Alternate".format(cls.__name__),
1232
(cls, ), attr)
1782
if sys.version_info.major == 2:
1783
cls = type(b"{}Alternate".format(cls.__name__),
1784
(cls, ), attr)
1785
else:
1786
cls = type("{}Alternate".format(cls.__name__),
1787
(cls, ), attr)
1233
1788
return cls
1234
1789
1235
1790
return wrapper
1236
1791
1237
1792
1239
1794
"se.bsnet.fukt.Mandos"})
1240
1795
class ClientDBus(Client, DBusObjectWithProperties):
1241
1796
"""A Client class using D-Bus
1242
1797
1243
1798
Attributes:
1244
1799
dbus_object_path: dbus.ObjectPath
1245
1800
bus: dbus.SystemBus()
1246
1801
"""
1247
1802
1248
1803
runtime_expansions = (Client.runtime_expansions
1249
1804
+ ("dbus_object_path", ))
1250
1805
1251
1806
_interface = "se.recompile.Mandos.Client"
1252
1807
1253
1808
# dbus.service.Object doesn't use super(), so we can't either.
1254
1255
def __init__(self, bus = None, *args, **kwargs):
1809
1810
def __init__(self, bus=None, *args, **kwargs):
1256
1811
self.bus = bus
1257
1812
Client.__init__(self, *args, **kwargs)
1258
1813
# Only now, when this client is initialized, can it show up on
1264
1819
"/clients/" + client_object_name)
1265
1820
DBusObjectWithProperties.__init__(self, self.bus,
1266
1821
self.dbus_object_path)
1267
1822
1268
1823
def notifychangeproperty(transform_func, dbus_name,
1269
1824
type_func=lambda x: x,
1270
1825
variant_level=1,
1272
1827
_interface=_interface):
1273
1828
""" Modify a variable so that it's a property which announces
1274
1829
its changes to DBus.
1275
1830
1276
1831
transform_fun: Function that takes a value and a variant_level
1277
1832
and transforms it to a D-Bus type.
1278
1833
dbus_name: D-Bus name of the variable
1281
1836
variant_level: D-Bus variant level. Default: 1
1282
1837
"""
1283
1838
attrname = "_{}".format(dbus_name)
1284
1839
1285
1840
def setter(self, value):
1286
1841
if hasattr(self, "dbus_object_path"):
1287
1842
if (not hasattr(self, attrname) or
1294
1849
else:
1295
1850
dbus_value = transform_func(
1296
1851
type_func(value),
1297
variant_level = variant_level)
1852
variant_level=variant_level)
1298
1853
self.PropertyChanged(dbus.String(dbus_name),
1299
1854
dbus_value)
1300
1855
self.PropertiesChanged(
1301
1856
_interface,
1302
dbus.Dictionary({ dbus.String(dbus_name):
1303
dbus_value }),
1857
dbus.Dictionary({dbus.String(dbus_name):
1858
dbus_value}),
1304
1859
dbus.Array())
1305
1860
setattr(self, attrname, value)
1306
1861
1307
1862
return property(lambda self: getattr(self, attrname), setter)
1308
1863
1309
1864
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1310
1865
approvals_pending = notifychangeproperty(dbus.Boolean,
1311
1866
"ApprovalPending",
1312
type_func = bool)
1867
type_func=bool)
1313
1868
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1314
1869
last_enabled = notifychangeproperty(datetime_to_dbus,
1315
1870
"LastEnabled")
1316
1871
checker = notifychangeproperty(
1317
1872
dbus.Boolean, "CheckerRunning",
1318
type_func = lambda checker: checker is not None)
1873
type_func=lambda checker: checker is not None)
1319
1874
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1320
1875
"LastCheckedOK")
1321
1876
last_checker_status = notifychangeproperty(dbus.Int16,
1326
1881
"ApprovedByDefault")
1327
1882
approval_delay = notifychangeproperty(
1328
1883
dbus.UInt64, "ApprovalDelay",
1329
type_func = lambda td: td.total_seconds() * 1000)
1884
type_func=lambda td: td.total_seconds() * 1000)
1330
1885
approval_duration = notifychangeproperty(
1331
1886
dbus.UInt64, "ApprovalDuration",
1332
type_func = lambda td: td.total_seconds() * 1000)
1887
type_func=lambda td: td.total_seconds() * 1000)
1333
1888
host = notifychangeproperty(dbus.String, "Host")
1334
1889
timeout = notifychangeproperty(
1335
1890
dbus.UInt64, "Timeout",
1336
type_func = lambda td: td.total_seconds() * 1000)
1891
type_func=lambda td: td.total_seconds() * 1000)
1337
1892
extended_timeout = notifychangeproperty(
1338
1893
dbus.UInt64, "ExtendedTimeout",
1339
type_func = lambda td: td.total_seconds() * 1000)
1894
type_func=lambda td: td.total_seconds() * 1000)
1340
1895
interval = notifychangeproperty(
1341
1896
dbus.UInt64, "Interval",
1342
type_func = lambda td: td.total_seconds() * 1000)
1897
type_func=lambda td: td.total_seconds() * 1000)
1343
1898
checker_command = notifychangeproperty(dbus.String, "Checker")
1344
1899
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1345
1900
invalidate_only=True)
1346
1901
1347
1902
del notifychangeproperty
1348
1903
1349
1904
def __del__(self, *args, **kwargs):
1350
1905
try:
1351
1906
self.remove_from_connection()
1354
1909
if hasattr(DBusObjectWithProperties, "__del__"):
1355
1910
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1356
1911
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)
1912
1913
def checker_callback(self, source, condition,
1914
connection, command, *args, **kwargs):
1915
ret = Client.checker_callback(self, source, condition,
1916
connection, command, *args,
1917
**kwargs)
1918
exitstatus = self.last_checker_status
1919
if exitstatus >= 0:
1364
1920
# Emit D-Bus signal
1365
1921
self.CheckerCompleted(dbus.Int16(exitstatus),
1366
dbus.Int64(condition),
1922
# This is specific to GNU libC
1923
dbus.Int64(exitstatus << 8),
1367
1924
dbus.String(command))
1368
1925
else:
1369
1926
# Emit D-Bus signal
1370
1927
self.CheckerCompleted(dbus.Int16(-1),
1371
dbus.Int64(condition),
1928
dbus.Int64(
1929
# This is specific to GNU libC
1930
(exitstatus << 8)
1931
| self.last_checker_signal),
1372
1932
dbus.String(command))
1373
1374
return Client.checker_callback(self, pid, condition, command,
1375
*args, **kwargs)
1376
1933
return ret
1934
1377
1935
def start_checker(self, *args, **kwargs):
1378
1936
old_checker_pid = getattr(self.checker, "pid", None)
1379
1937
r = Client.start_checker(self, *args, **kwargs)
1383
1941
# Emit D-Bus signal
1384
1942
self.CheckerStarted(self.current_checker_command)
1385
1943
return r
1386
1944
1387
1945
def _reset_approved(self):
1388
1946
self.approved = None
1389
1947
return False
1390
1948
1391
1949
def approve(self, value=True):
1392
1950
self.approved = value
1393
gobject.timeout_add(int(self.approval_duration.total_seconds()
1394
* 1000), self._reset_approved)
1951
GLib.timeout_add(int(self.approval_duration.total_seconds()
1952
* 1000), self._reset_approved)
1395
1953
self.send_changedstate()
1396
1397
## D-Bus methods, signals & properties
1398
1399
## Interfaces
1400
1401
## Signals
1402
1954
1955
# D-Bus methods, signals & properties
1956
1957
# Interfaces
1958
1959
# Signals
1960
1403
1961
# CheckerCompleted - signal
1404
1962
@dbus.service.signal(_interface, signature="nxs")
1405
1963
def CheckerCompleted(self, exitcode, waitstatus, command):
1406
1964
"D-Bus signal"
1407
1965
pass
1408
1966
1409
1967
# CheckerStarted - signal
1410
1968
@dbus.service.signal(_interface, signature="s")
1411
1969
def CheckerStarted(self, command):
1412
1970
"D-Bus signal"
1413
1971
pass
1414
1972
1415
1973
# PropertyChanged - signal
1416
1974
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1417
1975
@dbus.service.signal(_interface, signature="sv")
1418
1976
def PropertyChanged(self, property, value):
1419
1977
"D-Bus signal"
1420
1978
pass
1421
1979
1422
1980
# GotSecret - signal
1423
1981
@dbus.service.signal(_interface)
1424
1982
def GotSecret(self):
1427
1985
server to mandos-client
1428
1986
"""
1429
1987
pass
1430
1988
1431
1989
# Rejected - signal
1432
1990
@dbus.service.signal(_interface, signature="s")
1433
1991
def Rejected(self, reason):
1434
1992
"D-Bus signal"
1435
1993
pass
1436
1994
1437
1995
# NeedApproval - signal
1438
1996
@dbus.service.signal(_interface, signature="tb")
1439
1997
def NeedApproval(self, timeout, default):
1440
1998
"D-Bus signal"
1441
1999
return self.need_approval()
1442
1443
## Methods
1444
2000
2001
# Methods
2002
1445
2003
# Approve - method
1446
2004
@dbus.service.method(_interface, in_signature="b")
1447
2005
def Approve(self, value):
1448
2006
self.approve(value)
1449
2007
1450
2008
# CheckedOK - method
1451
2009
@dbus.service.method(_interface)
1452
2010
def CheckedOK(self):
1453
2011
self.checked_ok()
1454
2012
1455
2013
# Enable - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1456
2015
@dbus.service.method(_interface)
1457
2016
def Enable(self):
1458
2017
"D-Bus method"
1459
2018
self.enable()
1460
2019
1461
2020
# StartChecker - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1462
2022
@dbus.service.method(_interface)
1463
2023
def StartChecker(self):
1464
2024
"D-Bus method"
1465
2025
self.start_checker()
1466
2026
1467
2027
# Disable - method
2028
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1468
2029
@dbus.service.method(_interface)
1469
2030
def Disable(self):
1470
2031
"D-Bus method"
1471
2032
self.disable()
1472
2033
1473
2034
# StopChecker - method
2035
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1474
2036
@dbus.service.method(_interface)
1475
2037
def StopChecker(self):
1476
2038
self.stop_checker()
1477
1478
## Properties
1479
2039
2040
# Properties
2041
1480
2042
# ApprovalPending - property
1481
2043
@dbus_service_property(_interface, signature="b", access="read")
1482
2044
def ApprovalPending_dbus_property(self):
1483
2045
return dbus.Boolean(bool(self.approvals_pending))
1484
2046
1485
2047
# ApprovedByDefault - property
1486
2048
@dbus_service_property(_interface,
1487
2049
signature="b",
1490
2052
if value is None: # get
1491
2053
return dbus.Boolean(self.approved_by_default)
1492
2054
self.approved_by_default = bool(value)
1493
2055
1494
2056
# ApprovalDelay - property
1495
2057
@dbus_service_property(_interface,
1496
2058
signature="t",
1500
2062
return dbus.UInt64(self.approval_delay.total_seconds()
1501
2063
* 1000)
1502
2064
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1503
2065
1504
2066
# ApprovalDuration - property
1505
2067
@dbus_service_property(_interface,
1506
2068
signature="t",
1510
2072
return dbus.UInt64(self.approval_duration.total_seconds()
1511
2073
* 1000)
1512
2074
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1513
2075
1514
2076
# Name - property
2077
@dbus_annotations(
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1515
2079
@dbus_service_property(_interface, signature="s", access="read")
1516
2080
def Name_dbus_property(self):
1517
2081
return dbus.String(self.name)
1518
2082
2083
# KeyID - property
2084
@dbus_annotations(
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
@dbus_service_property(_interface, signature="s", access="read")
2087
def KeyID_dbus_property(self):
2088
return dbus.String(self.key_id)
2089
1519
2090
# Fingerprint - property
2091
@dbus_annotations(
2092
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1520
2093
@dbus_service_property(_interface, signature="s", access="read")
1521
2094
def Fingerprint_dbus_property(self):
1522
2095
return dbus.String(self.fingerprint)
1523
2096
1524
2097
# Host - property
1525
2098
@dbus_service_property(_interface,
1526
2099
signature="s",
1529
2102
if value is None: # get
1530
2103
return dbus.String(self.host)
1531
2104
self.host = str(value)
1532
2105
1533
2106
# Created - property
2107
@dbus_annotations(
2108
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1534
2109
@dbus_service_property(_interface, signature="s", access="read")
1535
2110
def Created_dbus_property(self):
1536
2111
return datetime_to_dbus(self.created)
1537
2112
1538
2113
# LastEnabled - property
1539
2114
@dbus_service_property(_interface, signature="s", access="read")
1540
2115
def LastEnabled_dbus_property(self):
1541
2116
return datetime_to_dbus(self.last_enabled)
1542
2117
1543
2118
# Enabled - property
1544
2119
@dbus_service_property(_interface,
1545
2120
signature="b",
1551
2126
self.enable()
1552
2127
else:
1553
2128
self.disable()
1554
2129
1555
2130
# LastCheckedOK - property
1556
2131
@dbus_service_property(_interface,
1557
2132
signature="s",
1561
2136
self.checked_ok()
1562
2137
return
1563
2138
return datetime_to_dbus(self.last_checked_ok)
1564
2139
1565
2140
# LastCheckerStatus - property
1566
2141
@dbus_service_property(_interface, signature="n", access="read")
1567
2142
def LastCheckerStatus_dbus_property(self):
1568
2143
return dbus.Int16(self.last_checker_status)
1569
2144
1570
2145
# Expires - property
1571
2146
@dbus_service_property(_interface, signature="s", access="read")
1572
2147
def Expires_dbus_property(self):
1573
2148
return datetime_to_dbus(self.expires)
1574
2149
1575
2150
# LastApprovalRequest - property
1576
2151
@dbus_service_property(_interface, signature="s", access="read")
1577
2152
def LastApprovalRequest_dbus_property(self):
1578
2153
return datetime_to_dbus(self.last_approval_request)
1579
2154
1580
2155
# Timeout - property
1581
2156
@dbus_service_property(_interface,
1582
2157
signature="t",
1597
2172
if (getattr(self, "disable_initiator_tag", None)
1598
2173
is None):
1599
2174
return
1600
gobject.source_remove(self.disable_initiator_tag)
1601
self.disable_initiator_tag = gobject.timeout_add(
2175
GLib.source_remove(self.disable_initiator_tag)
2176
self.disable_initiator_tag = GLib.timeout_add(
1602
2177
int((self.expires - now).total_seconds() * 1000),
1603
2178
self.disable)
1604
2179
1605
2180
# ExtendedTimeout - property
1606
2181
@dbus_service_property(_interface,
1607
2182
signature="t",
1611
2186
return dbus.UInt64(self.extended_timeout.total_seconds()
1612
2187
* 1000)
1613
2188
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1614
2189
1615
2190
# Interval - property
1616
2191
@dbus_service_property(_interface,
1617
2192
signature="t",
1624
2199
return
1625
2200
if self.enabled:
1626
2201
# Reschedule checker run
1627
gobject.source_remove(self.checker_initiator_tag)
1628
self.checker_initiator_tag = gobject.timeout_add(
2202
GLib.source_remove(self.checker_initiator_tag)
2203
self.checker_initiator_tag = GLib.timeout_add(
1629
2204
value, self.start_checker)
1630
self.start_checker() # Start one now, too
1631
2205
self.start_checker() # Start one now, too
2206
1632
2207
# Checker - property
1633
2208
@dbus_service_property(_interface,
1634
2209
signature="s",
1637
2212
if value is None: # get
1638
2213
return dbus.String(self.checker_command)
1639
2214
self.checker_command = str(value)
1640
2215
1641
2216
# CheckerRunning - property
1642
2217
@dbus_service_property(_interface,
1643
2218
signature="b",
1649
2224
self.start_checker()
1650
2225
else:
1651
2226
self.stop_checker()
1652
2227
1653
2228
# ObjectPath - property
2229
@dbus_annotations(
2230
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2231
"org.freedesktop.DBus.Deprecated": "true"})
1654
2232
@dbus_service_property(_interface, signature="o", access="read")
1655
2233
def ObjectPath_dbus_property(self):
1656
return self.dbus_object_path # is already a dbus.ObjectPath
1657
2234
return self.dbus_object_path # is already a dbus.ObjectPath
2235
1658
2236
# Secret = property
2237
@dbus_annotations(
2238
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2239
"invalidates"})
1659
2240
@dbus_service_property(_interface,
1660
2241
signature="ay",
1661
2242
access="write",
1662
2243
byte_arrays=True)
1663
2244
def Secret_dbus_property(self, value):
1664
2245
self.secret = bytes(value)
1665
2246
1666
2247
del _interface
1667
2248
1668
2249
1669
class ProxyClient(object):
1670
def __init__(self, child_pipe, fpr, address):
2250
class ProxyClient:
2251
def __init__(self, child_pipe, key_id, fpr, address):
1671
2252
self._pipe = child_pipe
1672
self._pipe.send(('init', fpr, address))
2253
self._pipe.send(('init', key_id, fpr, address))
1673
2254
if not self._pipe.recv():
1674
raise KeyError()
1675
2255
raise KeyError(key_id or fpr)
2256
1676
2257
def __getattribute__(self, name):
1677
2258
if name == '_pipe':
1678
2259
return super(ProxyClient, self).__getattribute__(name)
1681
2262
if data[0] == 'data':
1682
2263
return data[1]
1683
2264
if data[0] == 'function':
1684
2265
1685
2266
def func(*args, **kwargs):
1686
2267
self._pipe.send(('funcall', name, args, kwargs))
1687
2268
return self._pipe.recv()[1]
1688
2269
1689
2270
return func
1690
2271
1691
2272
def __setattr__(self, name, value):
1692
2273
if name == '_pipe':
1693
2274
return super(ProxyClient, self).__setattr__(name, value)
1696
2277
1697
2278
class ClientHandler(socketserver.BaseRequestHandler, object):
1698
2279
"""A class to handle client connections.
1699
2280
1700
2281
Instantiated once for each connection to handle it.
1701
2282
Note: This will run in its own forked process."""
1702
2283
1703
2284
def handle(self):
1704
2285
with contextlib.closing(self.server.child_pipe) as child_pipe:
1705
2286
logger.info("TCP connection from: %s",
1706
2287
str(self.client_address))
1707
2288
logger.debug("Pipe FD: %d",
1708
2289
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"))
2290
2291
session = gnutls.ClientSession(self.request)
2292
2293
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2294
# "+AES-256-CBC", "+SHA1",
2295
# "+COMP-NULL", "+CTYPE-OPENPGP",
2296
# "+DHE-DSS"))
1722
2297
# Use a fallback default, since this MUST be set.
1723
2298
priority = self.server.gnutls_priority
1724
2299
if priority is None:
1725
2300
priority = "NORMAL"
1726
gnutls.library.functions.gnutls_priority_set_direct(
1727
session._c_object, priority, None)
1728
2301
gnutls.priority_set_direct(session._c_object,
2302
priority.encode("utf-8"),
2303
None)
2304
1729
2305
# Start communication using the Mandos protocol
1730
2306
# Get protocol number
1731
2307
line = self.request.makefile().readline()
1736
2312
except (ValueError, IndexError, RuntimeError) as error:
1737
2313
logger.error("Unknown protocol version: %s", error)
1738
2314
return
1739
2315
1740
2316
# Start GnuTLS connection
1741
2317
try:
1742
2318
session.handshake()
1743
except gnutls.errors.GNUTLSError as error:
2319
except gnutls.Error as error:
1744
2320
logger.warning("Handshake failed: %s", error)
1745
2321
# Do not run session.bye() here: the session is not
1746
2322
# established. Just abandon the request.
1747
2323
return
1748
2324
logger.debug("Handshake succeeded")
1749
2325
1750
2326
approval_required = False
1751
2327
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,
2328
if gnutls.has_rawpk:
2329
fpr = b""
2330
try:
2331
key_id = self.key_id(
2332
self.peer_certificate(session))
2333
except (TypeError, gnutls.Error) as error:
2334
logger.warning("Bad certificate: %s", error)
2335
return
2336
logger.debug("Key ID: %s", key_id)
2337
2338
else:
2339
key_id = b""
2340
try:
2341
fpr = self.fingerprint(
2342
self.peer_certificate(session))
2343
except (TypeError, gnutls.Error) as error:
2344
logger.warning("Bad certificate: %s", error)
2345
return
2346
logger.debug("Fingerprint: %s", fpr)
2347
2348
try:
2349
client = ProxyClient(child_pipe, key_id, fpr,
1763
2350
self.client_address)
1764
2351
except KeyError:
1765
2352
return
1766
2353
1767
2354
if client.approval_delay:
1768
2355
delay = client.approval_delay
1769
2356
client.approvals_pending += 1
1770
2357
approval_required = True
1771
2358
1772
2359
while True:
1773
2360
if not client.enabled:
1774
2361
logger.info("Client %s is disabled",
1777
2364
# Emit D-Bus signal
1778
2365
client.Rejected("Disabled")
1779
2366
return
1780
2367
1781
2368
if client.approved or not client.approval_delay:
1782
#We are approved or approval is disabled
2369
# We are approved or approval is disabled
1783
2370
break
1784
2371
elif client.approved is None:
1785
2372
logger.info("Client %s needs approval",
1796
2383
# Emit D-Bus signal
1797
2384
client.Rejected("Denied")
1798
2385
return
1799
1800
#wait until timeout or approved
2386
2387
# wait until timeout or approved
1801
2388
time = datetime.datetime.now()
1802
2389
client.changedstate.acquire()
1803
2390
client.changedstate.wait(delay.total_seconds())
1816
2403
break
1817
2404
else:
1818
2405
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
2406
2407
try:
2408
session.send(client.secret)
2409
except gnutls.Error as error:
2410
logger.warning("gnutls send failed",
2411
exc_info=error)
2412
return
2413
1833
2414
logger.info("Sending secret to %s", client.name)
1834
2415
# bump the timeout using extended_timeout
1835
2416
client.bump_timeout(client.extended_timeout)
1836
2417
if self.server.use_dbus:
1837
2418
# Emit D-Bus signal
1838
2419
client.GotSecret()
1839
2420
1840
2421
finally:
1841
2422
if approval_required:
1842
2423
client.approvals_pending -= 1
1843
2424
try:
1844
2425
session.bye()
1845
except gnutls.errors.GNUTLSError as error:
2426
except gnutls.Error as error:
1846
2427
logger.warning("GnuTLS bye failed",
1847
2428
exc_info=error)
1848
2429
1849
2430
@staticmethod
1850
2431
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
2432
"Return the peer's certificate as a bytestring"
2433
try:
2434
cert_type = gnutls.certificate_type_get2(session._c_object,
2435
gnutls.CTYPE_PEERS)
2436
except AttributeError:
2437
cert_type = gnutls.certificate_type_get(session._c_object)
2438
if gnutls.has_rawpk:
2439
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2440
else:
2441
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2442
# If not a valid certificate type...
2443
if cert_type not in valid_cert_types:
2444
logger.info("Cert type %r not in %r", cert_type,
2445
valid_cert_types)
2446
# ...return invalid data
2447
return b""
1858
2448
list_size = ctypes.c_uint(1)
1859
cert_list = (gnutls.library.functions
1860
.gnutls_certificate_get_peers
2449
cert_list = (gnutls.certificate_get_peers
1861
2450
(session._c_object, ctypes.byref(list_size)))
1862
2451
if not bool(cert_list) and list_size.value != 0:
1863
raise gnutls.errors.GNUTLSError("error getting peer"
1864
" certificate")
2452
raise gnutls.Error("error getting peer certificate")
1865
2453
if list_size.value == 0:
1866
2454
return None
1867
2455
cert = cert_list[0]
1868
2456
return ctypes.string_at(cert.data, cert.size)
1869
2457
2458
@staticmethod
2459
def key_id(certificate):
2460
"Convert a certificate bytestring to a hexdigit key ID"
2461
# New GnuTLS "datum" with the public key
2462
datum = gnutls.datum_t(
2463
ctypes.cast(ctypes.c_char_p(certificate),
2464
ctypes.POINTER(ctypes.c_ubyte)),
2465
ctypes.c_uint(len(certificate)))
2466
# XXX all these need to be created in the gnutls "module"
2467
# New empty GnuTLS certificate
2468
pubkey = gnutls.pubkey_t()
2469
gnutls.pubkey_init(ctypes.byref(pubkey))
2470
# Import the raw public key into the certificate
2471
gnutls.pubkey_import(pubkey,
2472
ctypes.byref(datum),
2473
gnutls.X509_FMT_DER)
2474
# New buffer for the key ID
2475
buf = ctypes.create_string_buffer(32)
2476
buf_len = ctypes.c_size_t(len(buf))
2477
# Get the key ID from the raw public key into the buffer
2478
gnutls.pubkey_get_key_id(
2479
pubkey,
2480
gnutls.KEYID_USE_SHA256,
2481
ctypes.cast(ctypes.byref(buf),
2482
ctypes.POINTER(ctypes.c_ubyte)),
2483
ctypes.byref(buf_len))
2484
# Deinit the certificate
2485
gnutls.pubkey_deinit(pubkey)
2486
2487
# Convert the buffer to a Python bytestring
2488
key_id = ctypes.string_at(buf, buf_len.value)
2489
# Convert the bytestring to hexadecimal notation
2490
hex_key_id = binascii.hexlify(key_id).upper()
2491
return hex_key_id
2492
1870
2493
@staticmethod
1871
2494
def fingerprint(openpgp):
1872
2495
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1873
2496
# New GnuTLS "datum" with the OpenPGP public key
1874
datum = gnutls.library.types.gnutls_datum_t(
2497
datum = gnutls.datum_t(
1875
2498
ctypes.cast(ctypes.c_char_p(openpgp),
1876
2499
ctypes.POINTER(ctypes.c_ubyte)),
1877
2500
ctypes.c_uint(len(openpgp)))
1878
2501
# 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))
2502
crt = gnutls.openpgp_crt_t()
2503
gnutls.openpgp_crt_init(ctypes.byref(crt))
1882
2504
# 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)
2505
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2506
gnutls.OPENPGP_FMT_RAW)
1886
2507
# Verify the self signature in the key
1887
2508
crtverify = ctypes.c_uint()
1888
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1889
crt, 0, ctypes.byref(crtverify))
2509
gnutls.openpgp_crt_verify_self(crt, 0,
2510
ctypes.byref(crtverify))
1890
2511
if crtverify.value != 0:
1891
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1892
raise gnutls.errors.CertificateSecurityError(
1893
"Verify failed")
2512
gnutls.openpgp_crt_deinit(crt)
2513
raise gnutls.CertificateSecurityError(code
2514
=crtverify.value)
1894
2515
# New buffer for the fingerprint
1895
2516
buf = ctypes.create_string_buffer(20)
1896
2517
buf_len = ctypes.c_size_t()
1897
2518
# 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))
2519
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2520
ctypes.byref(buf_len))
1900
2521
# Deinit the certificate
1901
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2522
gnutls.openpgp_crt_deinit(crt)
1902
2523
# Convert the buffer to a Python bytestring
1903
2524
fpr = ctypes.string_at(buf, buf_len.value)
1904
2525
# Convert the bytestring to hexadecimal notation
1906
2527
return hex_fpr
1907
2528
1908
2529
1909
class MultiprocessingMixIn(object):
2530
class MultiprocessingMixIn:
1910
2531
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1911
2532
1912
2533
def sub_process_main(self, request, address):
1913
2534
try:
1914
2535
self.finish_request(request, address)
1915
2536
except Exception:
1916
2537
self.handle_error(request, address)
1917
2538
self.close_request(request)
1918
2539
1919
2540
def process_request(self, request, address):
1920
2541
"""Start a new process to process the request."""
1921
proc = multiprocessing.Process(target = self.sub_process_main,
1922
args = (request, address))
2542
proc = multiprocessing.Process(target=self.sub_process_main,
2543
args=(request, address))
1923
2544
proc.start()
1924
2545
return proc
1925
2546
1926
2547
1927
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2548
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1928
2549
""" adds a pipe to the MixIn """
1929
2550
1930
2551
def process_request(self, request, client_address):
1931
2552
"""Overrides and wraps the original process_request().
1932
2553
1933
2554
This function creates a new pipe in self.pipe
1934
2555
"""
1935
2556
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1936
2557
1937
2558
proc = MultiprocessingMixIn.process_request(self, request,
1938
2559
client_address)
1939
2560
self.child_pipe.close()
1940
2561
self.add_pipe(parent_pipe, proc)
1941
2562
1942
2563
def add_pipe(self, parent_pipe, proc):
1943
2564
"""Dummy function; override as necessary"""
1944
2565
raise NotImplementedError()
1945
2566
1946
2567
1947
2568
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1948
socketserver.TCPServer, object):
2569
socketserver.TCPServer):
1949
2570
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1950
2571
1951
2572
Attributes:
1952
2573
enabled: Boolean; whether this server is activated yet
1953
2574
interface: None or a network interface name (string)
1954
2575
use_ipv6: Boolean; to use IPv6 or not
1955
2576
"""
1956
2577
1957
2578
def __init__(self, server_address, RequestHandlerClass,
1958
2579
interface=None,
1959
2580
use_ipv6=True,
1969
2590
self.socketfd = socketfd
1970
2591
# Save the original socket.socket() function
1971
2592
self.socket_socket = socket.socket
2593
1972
2594
# To implement --socket, we monkey patch socket.socket.
1973
#
2595
#
1974
2596
# (When socketserver.TCPServer is a new-style class, we
1975
2597
# could make self.socket into a property instead of monkey
1976
2598
# patching socket.socket.)
1977
#
2599
#
1978
2600
# Create a one-time-only replacement for socket.socket()
1979
2601
@functools.wraps(socket.socket)
1980
2602
def socket_wrapper(*args, **kwargs):
1992
2614
# socket_wrapper(), if socketfd was set.
1993
2615
socketserver.TCPServer.__init__(self, server_address,
1994
2616
RequestHandlerClass)
1995
2617
1996
2618
def server_bind(self):
1997
2619
"""This overrides the normal server_bind() function
1998
2620
to bind to an interface if one was specified, and also NOT to
1999
2621
bind to an address or port if they were not specified."""
2622
global SO_BINDTODEVICE
2000
2623
if self.interface is not None:
2001
2624
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
2625
# Fall back to a hard-coded value which seems to be
2626
# common enough.
2627
logger.warning("SO_BINDTODEVICE not found, trying 25")
2628
SO_BINDTODEVICE = 25
2629
try:
2630
self.socket.setsockopt(
2631
socket.SOL_SOCKET, SO_BINDTODEVICE,
2632
(self.interface + "\0").encode("utf-8"))
2633
except socket.error as error:
2634
if error.errno == errno.EPERM:
2635
logger.error("No permission to bind to"
2636
" interface %s", self.interface)
2637
elif error.errno == errno.ENOPROTOOPT:
2638
logger.error("SO_BINDTODEVICE not available;"
2639
" cannot bind to interface %s",
2640
self.interface)
2641
elif error.errno == errno.ENODEV:
2642
logger.error("Interface %s does not exist,"
2643
" cannot bind", self.interface)
2644
else:
2645
raise
2023
2646
# Only bind(2) the socket if we really need to.
2024
2647
if self.server_address[0] or self.server_address[1]:
2648
if self.server_address[1]:
2649
self.allow_reuse_address = True
2025
2650
if not self.server_address[0]:
2026
2651
if self.address_family == socket.AF_INET6:
2027
any_address = "::" # in6addr_any
2652
any_address = "::" # in6addr_any
2028
2653
else:
2029
any_address = "0.0.0.0" # INADDR_ANY
2654
any_address = "0.0.0.0" # INADDR_ANY
2030
2655
self.server_address = (any_address,
2031
2656
self.server_address[1])
2032
2657
elif not self.server_address[1]:
2042
2667
2043
2668
class MandosServer(IPv6_TCPServer):
2044
2669
"""Mandos server.
2045
2670
2046
2671
Attributes:
2047
2672
clients: set of Client objects
2048
2673
gnutls_priority GnuTLS priority string
2049
2674
use_dbus: Boolean; to emit D-Bus signals or not
2050
2051
Assumes a gobject.MainLoop event loop.
2675
2676
Assumes a GLib.MainLoop event loop.
2052
2677
"""
2053
2678
2054
2679
def __init__(self, server_address, RequestHandlerClass,
2055
2680
interface=None,
2056
2681
use_ipv6=True,
2066
2691
self.gnutls_priority = gnutls_priority
2067
2692
IPv6_TCPServer.__init__(self, server_address,
2068
2693
RequestHandlerClass,
2069
interface = interface,
2070
use_ipv6 = use_ipv6,
2071
socketfd = socketfd)
2072
2694
interface=interface,
2695
use_ipv6=use_ipv6,
2696
socketfd=socketfd)
2697
2073
2698
def server_activate(self):
2074
2699
if self.enabled:
2075
2700
return socketserver.TCPServer.server_activate(self)
2076
2701
2077
2702
def enable(self):
2078
2703
self.enabled = True
2079
2704
2080
2705
def add_pipe(self, parent_pipe, proc):
2081
2706
# 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,
2707
GLib.io_add_watch(
2708
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2709
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2085
2710
functools.partial(self.handle_ipc,
2086
parent_pipe = parent_pipe,
2087
proc = proc))
2088
2711
parent_pipe=parent_pipe,
2712
proc=proc))
2713
2089
2714
def handle_ipc(self, source, condition,
2090
2715
parent_pipe=None,
2091
proc = None,
2716
proc=None,
2092
2717
client_object=None):
2093
2718
# error, or the other end of multiprocessing.Pipe has closed
2094
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2719
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2095
2720
# Wait for other process to exit
2096
2721
proc.join()
2097
2722
return False
2098
2723
2099
2724
# Read a request from the child
2100
2725
request = parent_pipe.recv()
2101
2726
command = request[0]
2102
2727
2103
2728
if command == 'init':
2104
fpr = request[1]
2105
address = request[2]
2106
2107
for c in self.clients.itervalues():
2108
if c.fingerprint == fpr:
2729
key_id = request[1].decode("ascii")
2730
fpr = request[2].decode("ascii")
2731
address = request[3]
2732
2733
for c in self.clients.values():
2734
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2735
"27AE41E4649B934CA495991B7852B855"):
2736
continue
2737
if key_id and c.key_id == key_id:
2738
client = c
2739
break
2740
if fpr and c.fingerprint == fpr:
2109
2741
client = c
2110
2742
break
2111
2743
else:
2112
logger.info("Client not found for fingerprint: %s, ad"
2113
"dress: %s", fpr, address)
2744
logger.info("Client not found for key ID: %s, address"
2745
": %s", key_id or fpr, address)
2114
2746
if self.use_dbus:
2115
2747
# Emit D-Bus signal
2116
mandos_dbus_service.ClientNotFound(fpr,
2748
mandos_dbus_service.ClientNotFound(key_id or fpr,
2117
2749
address[0])
2118
2750
parent_pipe.send(False)
2119
2751
return False
2120
2121
gobject.io_add_watch(
2122
parent_pipe.fileno(),
2123
gobject.IO_IN | gobject.IO_HUP,
2752
2753
GLib.io_add_watch(
2754
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2755
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2124
2756
functools.partial(self.handle_ipc,
2125
parent_pipe = parent_pipe,
2126
proc = proc,
2127
client_object = client))
2757
parent_pipe=parent_pipe,
2758
proc=proc,
2759
client_object=client))
2128
2760
parent_pipe.send(True)
2129
2761
# remove the old hook in favor of the new above hook on
2130
2762
# same fileno
2133
2765
funcname = request[1]
2134
2766
args = request[2]
2135
2767
kwargs = request[3]
2136
2768
2137
2769
parent_pipe.send(('data', getattr(client_object,
2138
2770
funcname)(*args,
2139
2771
**kwargs)))
2140
2772
2141
2773
if command == 'getattr':
2142
2774
attrname = request[1]
2143
if callable(client_object.__getattribute__(attrname)):
2775
if isinstance(client_object.__getattribute__(attrname),
2776
collections.abc.Callable):
2144
2777
parent_pipe.send(('function', ))
2145
2778
else:
2146
2779
parent_pipe.send((
2147
2780
'data', client_object.__getattribute__(attrname)))
2148
2781
2149
2782
if command == 'setattr':
2150
2783
attrname = request[1]
2151
2784
value = request[2]
2152
2785
setattr(client_object, attrname, value)
2153
2786
2154
2787
return True
2155
2788
2156
2789
2157
2790
def rfc3339_duration_to_delta(duration):
2158
2791
"""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)
2792
2793
>>> timedelta = datetime.timedelta
2794
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2795
True
2796
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2797
True
2798
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2799
True
2800
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2801
True
2802
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2803
True
2804
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2805
True
2806
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2807
True
2808
>>> del timedelta
2174
2809
"""
2175
2810
2176
2811
# Parsing an RFC 3339 duration with regular expressions is not
2177
2812
# possible - there would have to be multiple places for the same
2178
2813
# values, like seconds. The current code, while more esoteric, is
2179
2814
# cleaner without depending on a parsing library. If Python had a
2180
2815
# built-in library for parsing we would use it, but we'd like to
2181
2816
# avoid excessive use of external libraries.
2182
2817
2183
2818
# 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
2819
Token = collections.namedtuple("Token", (
2194
2820
"regexp", # To match token; if "value" is not None, must have
2195
2821
# a "group" containing digits
2227
2853
frozenset((token_year, token_month,
2228
2854
token_day, token_time,
2229
2855
token_week)))
2230
# Define starting values
2231
value = datetime.timedelta() # Value so far
2856
# Define starting values:
2857
# Value so far
2858
value = datetime.timedelta()
2232
2859
found_token = None
2233
followers = frozenset((token_duration,)) # Following valid tokens
2234
s = duration # String left to parse
2860
# Following valid tokens
2861
followers = frozenset((token_duration, ))
2862
# String left to parse
2863
s = duration
2235
2864
# Loop until end token is found
2236
2865
while found_token is not token_end:
2237
2866
# Search for any currently valid tokens
2253
2882
break
2254
2883
else:
2255
2884
# No currently valid tokens were found
2256
raise ValueError("Invalid RFC 3339 duration")
2885
raise ValueError("Invalid RFC 3339 duration: {!r}"
2886
.format(duration))
2257
2887
# End token found
2258
2888
return value
2259
2889
2260
2890
2261
2891
def string_to_delta(interval):
2262
2892
"""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)
2893
2894
>>> string_to_delta('7d') == datetime.timedelta(7)
2895
True
2896
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2897
True
2898
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2899
True
2900
>>> string_to_delta('24h') == datetime.timedelta(1)
2901
True
2902
>>> string_to_delta('1w') == datetime.timedelta(7)
2903
True
2904
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2905
True
2276
2906
"""
2277
2907
2278
2908
try:
2279
2909
return rfc3339_duration_to_delta(interval)
2280
2910
except ValueError:
2281
2911
pass
2282
2912
2283
2913
timevalue = datetime.timedelta(0)
2284
2914
for s in interval.split():
2285
2915
try:
2303
2933
return timevalue
2304
2934
2305
2935
2306
def daemon(nochdir = False, noclose = False):
2936
def daemon(nochdir=False, noclose=False):
2307
2937
"""See daemon(3). Standard BSD Unix function.
2308
2938
2309
2939
This should really exist as os.daemon, but it doesn't (yet)."""
2310
2940
if os.fork():
2311
2941
sys.exit()
2329
2959
2330
2960
2331
2961
def main():
2332
2962
2333
2963
##################################################################
2334
2964
# Parsing of options, both command line and config file
2335
2965
2336
2966
parser = argparse.ArgumentParser()
2337
2967
parser.add_argument("-v", "--version", action="version",
2338
version = "%(prog)s {}".format(version),
2968
version="%(prog)s {}".format(version),
2339
2969
help="show version number and exit")
2340
2970
parser.add_argument("-i", "--interface", metavar="IF",
2341
2971
help="Bind to interface IF")
2377
3007
parser.add_argument("--no-zeroconf", action="store_false",
2378
3008
dest="zeroconf", help="Do not use Zeroconf",
2379
3009
default=None)
2380
3010
2381
3011
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
3012
2388
3013
# 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
3014
if gnutls.has_rawpk:
3015
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3016
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3017
else:
3018
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3019
":+SIGN-DSA-SHA256")
3020
server_defaults = {"interface": "",
3021
"address": "",
3022
"port": "",
3023
"debug": "False",
3024
"priority": priority,
3025
"servicename": "Mandos",
3026
"use_dbus": "True",
3027
"use_ipv6": "True",
3028
"debuglevel": "",
3029
"restore": "True",
3030
"socket": "",
3031
"statedir": "/var/lib/mandos",
3032
"foreground": "False",
3033
"zeroconf": "True",
3034
}
3035
del priority
3036
2407
3037
# Parse config file for server-global settings
2408
server_config = configparser.SafeConfigParser(server_defaults)
3038
server_config = configparser.ConfigParser(server_defaults)
2409
3039
del server_defaults
2410
3040
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2411
# Convert the SafeConfigParser object to a dict
3041
# Convert the ConfigParser object to a dict
2412
3042
server_settings = server_config.defaults()
2413
3043
# Use the appropriate methods on the non-string config options
2414
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3044
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3045
"foreground", "zeroconf"):
2415
3046
server_settings[option] = server_config.getboolean("DEFAULT",
2416
3047
option)
2417
3048
if server_settings["port"]:
2427
3058
server_settings["socket"] = os.dup(server_settings
2428
3059
["socket"])
2429
3060
del server_config
2430
3061
2431
3062
# Override the settings from the config file with command line
2432
3063
# options, if set.
2433
3064
for option in ("interface", "address", "port", "debug",
2451
3082
if server_settings["debug"]:
2452
3083
server_settings["foreground"] = True
2453
3084
# Now we have our good server settings in "server_settings"
2454
3085
2455
3086
##################################################################
2456
3087
2457
3088
if (not server_settings["zeroconf"]
2458
3089
and not (server_settings["port"]
2459
3090
or server_settings["socket"] != "")):
2460
3091
parser.error("Needs port or socket to work without Zeroconf")
2461
3092
2462
3093
# For convenience
2463
3094
debug = server_settings["debug"]
2464
3095
debuglevel = server_settings["debuglevel"]
2468
3099
stored_state_file)
2469
3100
foreground = server_settings["foreground"]
2470
3101
zeroconf = server_settings["zeroconf"]
2471
3102
2472
3103
if debug:
2473
3104
initlogger(debug, logging.DEBUG)
2474
3105
else:
2477
3108
else:
2478
3109
level = getattr(logging, debuglevel.upper())
2479
3110
initlogger(debug, level)
2480
3111
2481
3112
if server_settings["servicename"] != "Mandos":
2482
3113
syslogger.setFormatter(
2483
3114
logging.Formatter('Mandos ({}) [%(process)d]:'
2484
3115
' %(levelname)s: %(message)s'.format(
2485
3116
server_settings["servicename"])))
2486
3117
2487
3118
# Parse config file with clients
2488
client_config = configparser.SafeConfigParser(Client
2489
.client_defaults)
3119
client_config = configparser.ConfigParser(Client.client_defaults)
2490
3120
client_config.read(os.path.join(server_settings["configdir"],
2491
3121
"clients.conf"))
2492
3122
2493
3123
global mandos_dbus_service
2494
3124
mandos_dbus_service = None
2495
3125
2496
3126
socketfd = None
2497
3127
if server_settings["socket"] != "":
2498
3128
socketfd = server_settings["socket"]
2510
3140
pidfilename = "/var/run/mandos.pid"
2511
3141
pidfile = None
2512
3142
try:
2513
pidfile = open(pidfilename, "w")
3143
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2514
3144
except IOError as e:
2515
3145
logger.error("Could not open file %r", pidfilename,
2516
3146
exc_info=e)
2517
2518
for name in ("_mandos", "mandos", "nobody"):
3147
3148
for name, group in (("_mandos", "_mandos"),
3149
("mandos", "mandos"),
3150
("nobody", "nogroup")):
2519
3151
try:
2520
3152
uid = pwd.getpwnam(name).pw_uid
2521
gid = pwd.getpwnam(name).pw_gid
3153
gid = pwd.getpwnam(group).pw_gid
2522
3154
break
2523
3155
except KeyError:
2524
3156
continue
2528
3160
try:
2529
3161
os.setgid(gid)
2530
3162
os.setuid(uid)
3163
if debug:
3164
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3165
gid))
2531
3166
except OSError as error:
3167
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3168
.format(uid, gid, os.strerror(error.errno)))
2532
3169
if error.errno != errno.EPERM:
2533
3170
raise
2534
3171
2535
3172
if debug:
2536
3173
# Enable all possible GnuTLS debugging
2537
3174
2538
3175
# "Use a log level over 10 to enable all debugging options."
2539
3176
# - GnuTLS manual
2540
gnutls.library.functions.gnutls_global_set_log_level(11)
2541
2542
@gnutls.library.types.gnutls_log_func
3177
gnutls.global_set_log_level(11)
3178
3179
@gnutls.log_func
2543
3180
def debug_gnutls(level, string):
2544
3181
logger.debug("GnuTLS: %s", string[:-1])
2545
2546
gnutls.library.functions.gnutls_global_set_log_function(
2547
debug_gnutls)
2548
3182
3183
gnutls.global_set_log_function(debug_gnutls)
3184
2549
3185
# Redirect stdin so all checkers get /dev/null
2550
3186
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2551
3187
os.dup2(null, sys.stdin.fileno())
2552
3188
if null > 2:
2553
3189
os.close(null)
2554
3190
2555
3191
# Need to fork before connecting to D-Bus
2556
3192
if not foreground:
2557
3193
# Close all input and output, do double fork, etc.
2558
3194
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
3195
3196
if gi.version_info < (3, 10, 2):
3197
# multiprocessing will use threads, so before we use GLib we
3198
# need to inform GLib that threads will be used.
3199
GLib.threads_init()
3200
2564
3201
global main_loop
2565
3202
# From the Avahi example code
2566
3203
DBusGMainLoop(set_as_default=True)
2567
main_loop = gobject.MainLoop()
3204
main_loop = GLib.MainLoop()
2568
3205
bus = dbus.SystemBus()
2569
3206
# End of Avahi example code
2570
3207
if use_dbus:
2575
3212
old_bus_name = dbus.service.BusName(
2576
3213
"se.bsnet.fukt.Mandos", bus,
2577
3214
do_not_queue=True)
2578
except dbus.exceptions.NameExistsException as e:
3215
except dbus.exceptions.DBusException as e:
2579
3216
logger.error("Disabling D-Bus:", exc_info=e)
2580
3217
use_dbus = False
2581
3218
server_settings["use_dbus"] = False
2583
3220
if zeroconf:
2584
3221
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2585
3222
service = AvahiServiceToSyslog(
2586
name = server_settings["servicename"],
2587
servicetype = "_mandos._tcp",
2588
protocol = protocol,
2589
bus = bus)
3223
name=server_settings["servicename"],
3224
servicetype="_mandos._tcp",
3225
protocol=protocol,
3226
bus=bus)
2590
3227
if server_settings["interface"]:
2591
3228
service.interface = if_nametoindex(
2592
3229
server_settings["interface"].encode("utf-8"))
2593
3230
2594
3231
global multiprocessing_manager
2595
3232
multiprocessing_manager = multiprocessing.Manager()
2596
3233
2597
3234
client_class = Client
2598
3235
if use_dbus:
2599
client_class = functools.partial(ClientDBus, bus = bus)
2600
3236
client_class = functools.partial(ClientDBus, bus=bus)
3237
2601
3238
client_settings = Client.config_parser(client_config)
2602
3239
old_client_settings = {}
2603
3240
clients_data = {}
2604
3241
2605
3242
# This is used to redirect stdout and stderr for checker processes
2606
3243
global wnull
2607
wnull = open(os.devnull, "w") # A writable /dev/null
3244
wnull = open(os.devnull, "w") # A writable /dev/null
2608
3245
# Only used if server is running in foreground but not in debug
2609
3246
# mode
2610
3247
if debug or not foreground:
2611
3248
wnull.close()
2612
3249
2613
3250
# Get client data and settings from last running state.
2614
3251
if server_settings["restore"]:
2615
3252
try:
2616
3253
with open(stored_state_path, "rb") as stored_state:
2617
clients_data, old_client_settings = pickle.load(
2618
stored_state)
3254
if sys.version_info.major == 2:
3255
clients_data, old_client_settings = pickle.load(
3256
stored_state)
3257
else:
3258
bytes_clients_data, bytes_old_client_settings = (
3259
pickle.load(stored_state, encoding="bytes"))
3260
# Fix bytes to strings
3261
# clients_data
3262
# .keys()
3263
clients_data = {(key.decode("utf-8")
3264
if isinstance(key, bytes)
3265
else key): value
3266
for key, value in
3267
bytes_clients_data.items()}
3268
del bytes_clients_data
3269
for key in clients_data:
3270
value = {(k.decode("utf-8")
3271
if isinstance(k, bytes) else k): v
3272
for k, v in
3273
clients_data[key].items()}
3274
clients_data[key] = value
3275
# .client_structure
3276
value["client_structure"] = [
3277
(s.decode("utf-8")
3278
if isinstance(s, bytes)
3279
else s) for s in
3280
value["client_structure"]]
3281
# .name, .host, and .checker_command
3282
for k in ("name", "host", "checker_command"):
3283
if isinstance(value[k], bytes):
3284
value[k] = value[k].decode("utf-8")
3285
if "key_id" not in value:
3286
value["key_id"] = ""
3287
elif "fingerprint" not in value:
3288
value["fingerprint"] = ""
3289
# old_client_settings
3290
# .keys()
3291
old_client_settings = {
3292
(key.decode("utf-8")
3293
if isinstance(key, bytes)
3294
else key): value
3295
for key, value in
3296
bytes_old_client_settings.items()}
3297
del bytes_old_client_settings
3298
# .host and .checker_command
3299
for value in old_client_settings.values():
3300
for attribute in ("host", "checker_command"):
3301
if isinstance(value[attribute], bytes):
3302
value[attribute] = (value[attribute]
3303
.decode("utf-8"))
2619
3304
os.remove(stored_state_path)
2620
3305
except IOError as e:
2621
3306
if e.errno == errno.ENOENT:
2629
3314
logger.warning("Could not load persistent state: "
2630
3315
"EOFError:",
2631
3316
exc_info=e)
2632
3317
2633
3318
with PGPEngine() as pgp:
2634
3319
for client_name, client in clients_data.items():
2635
3320
# Skip removed clients
2636
3321
if client_name not in client_settings:
2637
3322
continue
2638
3323
2639
3324
# Decide which value to use after restoring saved state.
2640
3325
# We have three different values: Old config file,
2641
3326
# new config file, and saved state.
2652
3337
client[name] = value
2653
3338
except KeyError:
2654
3339
pass
2655
3340
2656
3341
# Clients who has passed its expire date can still be
2657
# enabled if its last checker was successful. Clients
3342
# enabled if its last checker was successful. A Client
2658
3343
# whose checker succeeded before we stored its state is
2659
3344
# assumed to have successfully run all checkers during
2660
3345
# downtime.
2691
3376
client_name))
2692
3377
client["secret"] = (client_settings[client_name]
2693
3378
["secret"])
2694
3379
2695
3380
# Add/remove clients based on new changes made to config
2696
3381
for client_name in (set(old_client_settings)
2697
3382
- set(client_settings)):
2699
3384
for client_name in (set(client_settings)
2700
3385
- set(old_client_settings)):
2701
3386
clients_data[client_name] = client_settings[client_name]
2702
3387
2703
3388
# Create all client objects
2704
3389
for client_name, client in clients_data.items():
2705
3390
tcp_server.clients[client_name] = client_class(
2706
name = client_name,
2707
settings = client,
2708
server_settings = server_settings)
2709
3391
name=client_name,
3392
settings=client,
3393
server_settings=server_settings)
3394
2710
3395
if not tcp_server.clients:
2711
3396
logger.warning("No clients defined")
2712
3397
2713
3398
if not foreground:
2714
3399
if pidfile is not None:
3400
pid = os.getpid()
2715
3401
try:
2716
3402
with pidfile:
2717
pid = os.getpid()
2718
pidfile.write("{}\n".format(pid).encode("utf-8"))
3403
print(pid, file=pidfile)
2719
3404
except IOError:
2720
3405
logger.error("Could not write to file %r with PID %d",
2721
3406
pidfilename, pid)
2722
3407
del pidfile
2723
3408
del pidfilename
2724
2725
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2726
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2727
3409
3410
for termsig in (signal.SIGHUP, signal.SIGTERM):
3411
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3412
lambda: main_loop.quit() and False)
3413
2728
3414
if use_dbus:
2729
3415
2730
3416
@alternate_dbus_interfaces(
2731
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2732
class MandosDBusService(DBusObjectWithProperties):
3417
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3418
class MandosDBusService(DBusObjectWithObjectManager):
2733
3419
"""A D-Bus proxy object"""
2734
3420
2735
3421
def __init__(self):
2736
3422
dbus.service.Object.__init__(self, bus, "/")
2737
3423
2738
3424
_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
3425
2746
3426
@dbus.service.signal(_interface, signature="o")
2747
3427
def ClientAdded(self, objpath):
2748
3428
"D-Bus signal"
2749
3429
pass
2750
3430
2751
3431
@dbus.service.signal(_interface, signature="ss")
2752
def ClientNotFound(self, fingerprint, address):
3432
def ClientNotFound(self, key_id, address):
2753
3433
"D-Bus signal"
2754
3434
pass
2755
3435
3436
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3437
"true"})
2756
3438
@dbus.service.signal(_interface, signature="os")
2757
3439
def ClientRemoved(self, objpath, name):
2758
3440
"D-Bus signal"
2759
3441
pass
2760
3442
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3444
"true"})
2761
3445
@dbus.service.method(_interface, out_signature="ao")
2762
3446
def GetAllClients(self):
2763
3447
"D-Bus method"
2764
3448
return dbus.Array(c.dbus_object_path for c in
2765
tcp_server.clients.itervalues())
2766
3449
tcp_server.clients.values())
3450
3451
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3452
"true"})
2767
3453
@dbus.service.method(_interface,
2768
3454
out_signature="a{oa{sv}}")
2769
3455
def GetAllClientsWithProperties(self):
2770
3456
"D-Bus method"
2771
3457
return dbus.Dictionary(
2772
{ c.dbus_object_path: c.GetAll("")
2773
for c in tcp_server.clients.itervalues() },
3458
{c.dbus_object_path: c.GetAll(
3459
"se.recompile.Mandos.Client")
3460
for c in tcp_server.clients.values()},
2774
3461
signature="oa{sv}")
2775
3462
2776
3463
@dbus.service.method(_interface, in_signature="o")
2777
3464
def RemoveClient(self, object_path):
2778
3465
"D-Bus method"
2779
for c in tcp_server.clients.itervalues():
3466
for c in tcp_server.clients.values():
2780
3467
if c.dbus_object_path == object_path:
2781
3468
del tcp_server.clients[c.name]
2782
3469
c.remove_from_connection()
2783
# Don't signal anything except ClientRemoved
3470
# Don't signal the disabling
2784
3471
c.disable(quiet=True)
2785
# Emit D-Bus signal
2786
self.ClientRemoved(object_path, c.name)
3472
# Emit D-Bus signal for removal
3473
self.client_removed_signal(c)
2787
3474
return
2788
3475
raise KeyError(object_path)
2789
3476
2790
3477
del _interface
2791
3478
3479
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3480
out_signature="a{oa{sa{sv}}}")
3481
def GetManagedObjects(self):
3482
"""D-Bus method"""
3483
return dbus.Dictionary(
3484
{client.dbus_object_path:
3485
dbus.Dictionary(
3486
{interface: client.GetAll(interface)
3487
for interface in
3488
client._get_all_interface_names()})
3489
for client in tcp_server.clients.values()})
3490
3491
def client_added_signal(self, client):
3492
"""Send the new standard signal and the old signal"""
3493
if use_dbus:
3494
# New standard signal
3495
self.InterfacesAdded(
3496
client.dbus_object_path,
3497
dbus.Dictionary(
3498
{interface: client.GetAll(interface)
3499
for interface in
3500
client._get_all_interface_names()}))
3501
# Old signal
3502
self.ClientAdded(client.dbus_object_path)
3503
3504
def client_removed_signal(self, client):
3505
"""Send the new standard signal and the old signal"""
3506
if use_dbus:
3507
# New standard signal
3508
self.InterfacesRemoved(
3509
client.dbus_object_path,
3510
client._get_all_interface_names())
3511
# Old signal
3512
self.ClientRemoved(client.dbus_object_path,
3513
client.name)
3514
2792
3515
mandos_dbus_service = MandosDBusService()
2793
3516
3517
# Save modules to variables to exempt the modules from being
3518
# unloaded before the function registered with atexit() is run.
3519
mp = multiprocessing
3520
wn = wnull
3521
2794
3522
def cleanup():
2795
3523
"Cleanup function; run on exit"
2796
3524
if zeroconf:
2797
3525
service.cleanup()
2798
2799
multiprocessing.active_children()
2800
wnull.close()
3526
3527
mp.active_children()
3528
wn.close()
2801
3529
if not (tcp_server.clients or client_settings):
2802
3530
return
2803
3531
2804
3532
# Store client before exiting. Secrets are encrypted with key
2805
3533
# based on what config file has. If config file is
2806
3534
# removed/edited, old secret will thus be unrecovable.
2807
3535
clients = {}
2808
3536
with PGPEngine() as pgp:
2809
for client in tcp_server.clients.itervalues():
3537
for client in tcp_server.clients.values():
2810
3538
key = client_settings[client.name]["secret"]
2811
3539
client.encrypted_secret = pgp.encrypt(client.secret,
2812
3540
key)
2813
3541
client_dict = {}
2814
3542
2815
3543
# A list of attributes that can not be pickled
2816
3544
# + secret.
2817
exclude = { "bus", "changedstate", "secret",
2818
"checker", "server_settings" }
3545
exclude = {"bus", "changedstate", "secret",
3546
"checker", "server_settings"}
2819
3547
for name, typ in inspect.getmembers(dbus.service
2820
3548
.Object):
2821
3549
exclude.add(name)
2822
3550
2823
3551
client_dict["encrypted_secret"] = (client
2824
3552
.encrypted_secret)
2825
3553
for attr in client.client_structure:
2826
3554
if attr not in exclude:
2827
3555
client_dict[attr] = getattr(client, attr)
2828
3556
2829
3557
clients[client.name] = client_dict
2830
3558
del client_settings[client.name]["secret"]
2831
3559
2832
3560
try:
2833
3561
with tempfile.NamedTemporaryFile(
2834
3562
mode='wb',
2836
3564
prefix='clients-',
2837
3565
dir=os.path.dirname(stored_state_path),
2838
3566
delete=False) as stored_state:
2839
pickle.dump((clients, client_settings), stored_state)
3567
pickle.dump((clients, client_settings), stored_state,
3568
protocol=2)
2840
3569
tempname = stored_state.name
2841
3570
os.rename(tempname, stored_state_path)
2842
3571
except (IOError, OSError) as e:
2852
3581
logger.warning("Could not save persistent state:",
2853
3582
exc_info=e)
2854
3583
raise
2855
3584
2856
3585
# Delete all clients, and settings from config
2857
3586
while tcp_server.clients:
2858
3587
name, client = tcp_server.clients.popitem()
2859
3588
if use_dbus:
2860
3589
client.remove_from_connection()
2861
# Don't signal anything except ClientRemoved
3590
# Don't signal the disabling
2862
3591
client.disable(quiet=True)
3592
# Emit D-Bus signal for removal
2863
3593
if use_dbus:
2864
# Emit D-Bus signal
2865
mandos_dbus_service.ClientRemoved(
2866
client.dbus_object_path, client.name)
3594
mandos_dbus_service.client_removed_signal(client)
2867
3595
client_settings.clear()
2868
3596
2869
3597
atexit.register(cleanup)
2870
2871
for client in tcp_server.clients.itervalues():
3598
3599
for client in tcp_server.clients.values():
2872
3600
if use_dbus:
2873
# Emit D-Bus signal
2874
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3601
# Emit D-Bus signal for adding
3602
mandos_dbus_service.client_added_signal(client)
2875
3603
# Need to initiate checking of clients
2876
3604
if client.enabled:
2877
3605
client.init_checker()
2878
3606
2879
3607
tcp_server.enable()
2880
3608
tcp_server.server_activate()
2881
3609
2882
3610
# Find out what port we got
2883
3611
if zeroconf:
2884
3612
service.port = tcp_server.socket.getsockname()[1]
2889
3617
else: # IPv4
2890
3618
logger.info("Now listening on address %r, port %d",
2891
3619
*tcp_server.socket.getsockname())
2892
2893
#service.interface = tcp_server.socket.getsockname()[3]
2894
3620
3621
# service.interface = tcp_server.socket.getsockname()[3]
3622
2895
3623
try:
2896
3624
if zeroconf:
2897
3625
# From the Avahi example code
2902
3630
cleanup()
2903
3631
sys.exit(1)
2904
3632
# 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
3633
3634
GLib.io_add_watch(
3635
GLib.IOChannel.unix_new(tcp_server.fileno()),
3636
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3637
lambda *args, **kwargs: (tcp_server.handle_request
3638
(*args[2:], **kwargs) or True))
3639
2911
3640
logger.debug("Starting main loop")
2912
3641
main_loop.run()
2913
3642
except AvahiError as error:
2922
3651
# Must run before the D-Bus bus name gets deregistered
2923
3652
cleanup()
2924
3653
3654
3655
def should_only_run_tests():
3656
parser = argparse.ArgumentParser(add_help=False)
3657
parser.add_argument("--check", action='store_true')
3658
args, unknown_args = parser.parse_known_args()
3659
run_tests = args.check
3660
if run_tests:
3661
# Remove --check argument from sys.argv
3662
sys.argv[1:] = unknown_args
3663
return run_tests
3664
3665
# Add all tests from doctest strings
3666
def load_tests(loader, tests, none):
3667
import doctest
3668
tests.addTests(doctest.DocTestSuite())
3669
return tests
2925
3670
2926
3671
if __name__ == '__main__':
2927
main()
3672
try:
3673
if should_only_run_tests():
3674
# Call using ./mandos --check [--verbose]
3675
unittest.main()
3676
else:
3677
main()
3678
finally:
3679
logging.shutdown()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0