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