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