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