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