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 756
- compare with another revision
- download diff
- download tarball
- view history from revision 756
- Committer: Teddy Hogeborn
- Date: 2015-05-31 20:12:27 UTC
- mfrom: (749.1.2 multiprocessing-exec)
- Revision ID: teddy@recompile.se-20150531201227-u3n1z1ito5siqh7c
Merge change to use multiprocessing module to run checkers.
- 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
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
427
def call_pipe(connection, # : multiprocessing.Connection
836
428
func, *args, **kwargs):
837
429
"""This function is meant to be called by multiprocessing.Process
838
430
839
431
This function runs func(*args, **kwargs), and writes the resulting
840
432
return value on the provided multiprocessing.Connection.
841
433
"""
842
434
connection.send(func(*args, **kwargs))
843
435
connection.close()
844
436
845
846
class Client:
437
class Client(object):
847
438
"""A representation of a client host served by this server.
848
439
849
440
Attributes:
850
441
approved: bool(); 'None' if not yet approved/disapproved
851
442
approval_delay: datetime.timedelta(); Time to wait for approval
852
443
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
444
checker: subprocess.Popen(); a running checker process used
445
to see if the client lives.
446
'None' if no process is running.
447
checker_callback_tag: a gobject event source tag, or None
857
448
checker_command: string; External command which is run to check
858
449
if client lives. %() expansions are done at
859
450
runtime with vars(self) as dict, so that for
860
451
instance %(name)s can be used in the command.
861
checker_initiator_tag: a GLib event source tag, or None
452
checker_initiator_tag: a gobject event source tag, or None
862
453
created: datetime.datetime(); (UTC) object creation
863
454
client_structure: Object describing what attributes a client has
864
455
and is used for storing the client at exit
865
456
current_checker_command: string; current running checker_command
866
disable_initiator_tag: a GLib event source tag, or None
457
disable_initiator_tag: a gobject event source tag, or None
867
458
enabled: bool()
868
459
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
460
uniquely identify the client
872
461
host: string; available for use by the checker command
873
462
interval: datetime.timedelta(); How often to start a new checker
874
463
last_approval_request: datetime.datetime(); (UTC) or None
890
479
disabled, or None
891
480
server_settings: The server_settings dict from main()
892
481
"""
893
482
894
483
runtime_expansions = ("approval_delay", "approval_duration",
895
"created", "enabled", "expires", "key_id",
484
"created", "enabled", "expires",
896
485
"fingerprint", "host", "interval",
897
486
"last_approval_request", "last_checked_ok",
898
487
"last_enabled", "name", "timeout")
907
496
"approved_by_default": "True",
908
497
"enabled": "True",
909
498
}
910
499
911
500
@staticmethod
912
501
def config_parser(config):
913
502
"""Construct a new dict of client settings of this form:
920
509
for client_name in config.sections():
921
510
section = dict(config.items(client_name))
922
511
client = settings[client_name] = {}
923
512
924
513
client["host"] = section["host"]
925
514
# Reformat values from string types to Python types
926
515
client["approved_by_default"] = config.getboolean(
927
516
client_name, "approved_by_default")
928
517
client["enabled"] = config.getboolean(client_name,
929
518
"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(" ", ""))
519
520
# Uppercase and remove spaces from fingerprint for later
521
# comparison purposes with return value from the
522
# fingerprint() function
936
523
client["fingerprint"] = (section["fingerprint"].upper()
937
524
.replace(" ", ""))
938
525
if "secret" in section:
939
client["secret"] = codecs.decode(section["secret"]
940
.encode("utf-8"),
941
"base64")
526
client["secret"] = section["secret"].decode("base64")
942
527
elif "secfile" in section:
943
528
with open(os.path.expanduser(os.path.expandvars
944
529
(section["secfile"])),
959
544
client["last_approval_request"] = None
960
545
client["last_checked_ok"] = None
961
546
client["last_checker_status"] = -2
962
547
963
548
return settings
964
965
def __init__(self, settings, name=None, server_settings=None):
549
550
def __init__(self, settings, name = None, server_settings=None):
966
551
self.name = name
967
552
if server_settings is None:
968
553
server_settings = {}
970
555
# adding all client settings
971
556
for setting, value in settings.items():
972
557
setattr(self, setting, value)
973
558
974
559
if self.enabled:
975
560
if not hasattr(self, "last_enabled"):
976
561
self.last_enabled = datetime.datetime.utcnow()
980
565
else:
981
566
self.last_enabled = None
982
567
self.expires = None
983
568
984
569
logger.debug("Creating client %r", self.name)
985
logger.debug(" Key ID: %s", self.key_id)
986
570
logger.debug(" Fingerprint: %s", self.fingerprint)
987
571
self.created = settings.get("created",
988
572
datetime.datetime.utcnow())
989
573
990
574
# attributes specific for this server instance
991
575
self.checker = None
992
576
self.checker_initiator_tag = None
998
582
self.changedstate = multiprocessing_manager.Condition(
999
583
multiprocessing_manager.Lock())
1000
584
self.client_structure = [attr
1001
for attr in self.__dict__.keys()
585
for attr in self.__dict__.iterkeys()
1002
586
if not attr.startswith("_")]
1003
587
self.client_structure.append("client_structure")
1004
588
1005
589
for name, t in inspect.getmembers(
1006
590
type(self), lambda obj: isinstance(obj, property)):
1007
591
if not name.startswith("_"):
1008
592
self.client_structure.append(name)
1009
593
1010
594
# Send notice to process children that client state has changed
1011
595
def send_changedstate(self):
1012
596
with self.changedstate:
1013
597
self.changedstate.notify_all()
1014
598
1015
599
def enable(self):
1016
600
"""Start this client's checker and timeout hooks"""
1017
601
if getattr(self, "enabled", False):
1022
606
self.last_enabled = datetime.datetime.utcnow()
1023
607
self.init_checker()
1024
608
self.send_changedstate()
1025
609
1026
610
def disable(self, quiet=True):
1027
611
"""Disable this client."""
1028
612
if not getattr(self, "enabled", False):
1030
614
if not quiet:
1031
615
logger.info("Disabling client %s", self.name)
1032
616
if getattr(self, "disable_initiator_tag", None) is not None:
1033
GLib.source_remove(self.disable_initiator_tag)
617
gobject.source_remove(self.disable_initiator_tag)
1034
618
self.disable_initiator_tag = None
1035
619
self.expires = None
1036
620
if getattr(self, "checker_initiator_tag", None) is not None:
1037
GLib.source_remove(self.checker_initiator_tag)
621
gobject.source_remove(self.checker_initiator_tag)
1038
622
self.checker_initiator_tag = None
1039
623
self.stop_checker()
1040
624
self.enabled = False
1041
625
if not quiet:
1042
626
self.send_changedstate()
1043
# Do not run this again if called by a GLib.timeout_add
627
# Do not run this again if called by a gobject.timeout_add
1044
628
return False
1045
629
1046
630
def __del__(self):
1047
631
self.disable()
1048
632
1049
633
def init_checker(self):
1050
634
# Schedule a new checker to be started an 'interval' from now,
1051
635
# and every interval from then on.
1052
636
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)),
637
gobject.source_remove(self.checker_initiator_tag)
638
self.checker_initiator_tag = gobject.timeout_add(
639
int(self.interval.total_seconds() * 1000),
1057
640
self.start_checker)
1058
641
# Schedule a disable() when 'timeout' has passed
1059
642
if self.disable_initiator_tag is not None:
1060
GLib.source_remove(self.disable_initiator_tag)
1061
self.disable_initiator_tag = GLib.timeout_add(
643
gobject.source_remove(self.disable_initiator_tag)
644
self.disable_initiator_tag = gobject.timeout_add(
1062
645
int(self.timeout.total_seconds() * 1000), self.disable)
1063
646
# Also start a new checker *right now*.
1064
647
self.start_checker()
1065
648
1066
649
def checker_callback(self, source, condition, connection,
1067
650
command):
1068
651
"""The checker has completed, so take appropriate actions."""
652
self.checker_callback_tag = None
653
self.checker = None
1069
654
# Read return code from connection (see call_pipe)
1070
655
returncode = connection.recv()
1071
656
connection.close()
1072
if self.checker is not None:
1073
self.checker.join()
1074
self.checker_callback_tag = None
1075
self.checker = None
1076
657
1077
658
if returncode >= 0:
1078
659
self.last_checker_status = returncode
1079
660
self.last_checker_signal = None
1089
670
logger.warning("Checker for %(name)s crashed?",
1090
671
vars(self))
1091
672
return False
1092
673
1093
674
def checked_ok(self):
1094
675
"""Assert that the client has been seen, alive and well."""
1095
676
self.last_checked_ok = datetime.datetime.utcnow()
1096
677
self.last_checker_status = 0
1097
678
self.last_checker_signal = None
1098
679
self.bump_timeout()
1099
680
1100
681
def bump_timeout(self, timeout=None):
1101
682
"""Bump up the timeout for this client."""
1102
683
if timeout is None:
1103
684
timeout = self.timeout
1104
685
if self.disable_initiator_tag is not None:
1105
GLib.source_remove(self.disable_initiator_tag)
686
gobject.source_remove(self.disable_initiator_tag)
1106
687
self.disable_initiator_tag = None
1107
688
if getattr(self, "enabled", False):
1108
self.disable_initiator_tag = GLib.timeout_add(
689
self.disable_initiator_tag = gobject.timeout_add(
1109
690
int(timeout.total_seconds() * 1000), self.disable)
1110
691
self.expires = datetime.datetime.utcnow() + timeout
1111
692
1112
693
def need_approval(self):
1113
694
self.last_approval_request = datetime.datetime.utcnow()
1114
695
1115
696
def start_checker(self):
1116
697
"""Start a new checker subprocess if one is not running.
1117
698
1118
699
If a checker already exists, leave it running and do
1119
700
nothing."""
1120
701
# The reason for not killing a running checker is that if we
1125
706
# checkers alone, the checker would have to take more time
1126
707
# than 'timeout' for the client to be disabled, which is as it
1127
708
# should be.
1128
709
1129
710
if self.checker is not None and not self.checker.is_alive():
1130
711
logger.warning("Checker was not alive; joining")
1131
712
self.checker.join()
1134
715
if self.checker is None:
1135
716
# Escape attributes for the shell
1136
717
escaped_attrs = {
1137
attr: shlex.quote(str(getattr(self, attr)))
1138
for attr in self.runtime_expansions}
718
attr: re.escape(str(getattr(self, attr)))
719
for attr in self.runtime_expansions }
1139
720
try:
1140
721
command = self.checker_command % escaped_attrs
1141
722
except TypeError as error:
1153
734
# The exception is when not debugging but nevertheless
1154
735
# running in the foreground; use the previously
1155
736
# created wnull.
1156
popen_args = {"close_fds": True,
1157
"shell": True,
1158
"cwd": "/"}
737
popen_args = { "close_fds": True,
738
"shell": True,
739
"cwd": "/" }
1159
740
if (not self.server_settings["debug"]
1160
741
and self.server_settings["foreground"]):
1161
742
popen_args.update({"stdout": wnull,
1162
"stderr": wnull})
1163
pipe = multiprocessing.Pipe(duplex=False)
743
"stderr": wnull })
744
pipe = multiprocessing.Pipe(duplex = False)
1164
745
self.checker = multiprocessing.Process(
1165
target=call_pipe,
1166
args=(pipe[1], subprocess.call, command),
1167
kwargs=popen_args)
746
target = call_pipe,
747
args = (pipe[1], subprocess.call, command),
748
kwargs = popen_args)
1168
749
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,
750
self.checker_callback_tag = gobject.io_add_watch(
751
pipe[0].fileno(), gobject.IO_IN,
1172
752
self.checker_callback, pipe[0], command)
1173
# Re-run this periodically if run by GLib.timeout_add
753
# Re-run this periodically if run by gobject.timeout_add
1174
754
return True
1175
755
1176
756
def stop_checker(self):
1177
757
"""Force the checker process, if any, to stop."""
1178
758
if self.checker_callback_tag:
1179
GLib.source_remove(self.checker_callback_tag)
759
gobject.source_remove(self.checker_callback_tag)
1180
760
self.checker_callback_tag = None
1181
761
if getattr(self, "checker", None) is None:
1182
762
return
1191
771
byte_arrays=False):
1192
772
"""Decorators for marking methods of a DBusObjectWithProperties to
1193
773
become properties on the D-Bus.
1194
774
1195
775
The decorated method will be called with no arguments by "Get"
1196
776
and with one argument by "Set".
1197
777
1198
778
The parameters, where they are supported, are the same as
1199
779
dbus.service.method, except there is only "signature", since the
1200
780
type from Get() and the type sent to Set() is the same.
1204
784
if byte_arrays and signature != "ay":
1205
785
raise ValueError("Byte arrays not supported for non-'ay'"
1206
786
" signature {!r}".format(signature))
1207
787
1208
788
def decorator(func):
1209
789
func._dbus_is_property = True
1210
790
func._dbus_interface = dbus_interface
1213
793
func._dbus_name = func.__name__
1214
794
if func._dbus_name.endswith("_dbus_property"):
1215
795
func._dbus_name = func._dbus_name[:-14]
1216
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
796
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1217
797
return func
1218
798
1219
799
return decorator
1220
800
1221
801
1222
802
def dbus_interface_annotations(dbus_interface):
1223
803
"""Decorator for marking functions returning interface annotations
1224
804
1225
805
Usage:
1226
806
1227
807
@dbus_interface_annotations("org.example.Interface")
1228
808
def _foo(self): # Function name does not matter
1229
809
return {"org.freedesktop.DBus.Deprecated": "true",
1230
810
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1231
811
"false"}
1232
812
"""
1233
813
1234
814
def decorator(func):
1235
815
func._dbus_is_interface = True
1236
816
func._dbus_interface = dbus_interface
1237
817
func._dbus_name = dbus_interface
1238
818
return func
1239
819
1240
820
return decorator
1241
821
1242
822
1243
823
def dbus_annotations(annotations):
1244
824
"""Decorator to annotate D-Bus methods, signals or properties
1245
825
Usage:
1246
826
1247
827
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1248
828
"org.freedesktop.DBus.Property."
1249
829
"EmitsChangedSignal": "false"})
1251
831
access="r")
1252
832
def Property_dbus_property(self):
1253
833
return dbus.Boolean(False)
1254
1255
See also the DBusObjectWithAnnotations class.
1256
834
"""
1257
835
1258
836
def decorator(func):
1259
837
func._dbus_annotations = annotations
1260
838
return func
1261
839
1262
840
return decorator
1263
841
1264
842
1280
858
pass
1281
859
1282
860
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.
861
class DBusObjectWithProperties(dbus.service.Object):
862
"""A D-Bus object with properties.
863
864
Classes inheriting from this can use the dbus_service_property
865
decorator to expose methods as D-Bus properties. It exposes the
866
standard Get(), Set(), and GetAll() methods on the D-Bus.
1288
867
"""
1289
868
1290
869
@staticmethod
1291
870
def _is_dbus_thing(thing):
1292
871
"""Returns a function testing if an attribute is a D-Bus thing
1293
872
1294
873
If called like _is_dbus_thing("method") it returns a function
1295
874
suitable for use as predicate to inspect.getmembers().
1296
875
"""
1297
876
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1298
877
False)
1299
878
1300
879
def _get_all_dbus_things(self, thing):
1301
880
"""Returns a generator of (name, attribute) pairs
1302
881
"""
1305
884
for cls in self.__class__.__mro__
1306
885
for name, athing in
1307
886
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
887
1380
888
def _get_dbus_property(self, interface_name, property_name):
1381
889
"""Returns a bound method if one exists which is a D-Bus
1382
890
property with the specified name and interface.
1387
895
if (value._dbus_name == property_name
1388
896
and value._dbus_interface == interface_name):
1389
897
return value.__get__(self)
1390
898
1391
899
# No such property
1392
900
raise DBusPropertyNotFound("{}:{}.{}".format(
1393
901
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
902
1404
903
@dbus.service.method(dbus.PROPERTIES_IFACE,
1405
904
in_signature="ss",
1406
905
out_signature="v")
1414
913
if not hasattr(value, "variant_level"):
1415
914
return value
1416
915
return type(value)(value, variant_level=value.variant_level+1)
1417
916
1418
917
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1419
918
def Set(self, interface_name, property_name, value):
1420
919
"""Standard D-Bus property Set() method, see D-Bus standard.
1429
928
raise ValueError("Byte arrays not supported for non-"
1430
929
"'ay' signature {!r}"
1431
930
.format(prop._dbus_signature))
1432
value = dbus.ByteArray(bytes(value))
931
value = dbus.ByteArray(b''.join(chr(byte)
932
for byte in value))
1433
933
prop(value)
1434
934
1435
935
@dbus.service.method(dbus.PROPERTIES_IFACE,
1436
936
in_signature="s",
1437
937
out_signature="a{sv}")
1438
938
def GetAll(self, interface_name):
1439
939
"""Standard D-Bus property GetAll() method, see D-Bus
1440
940
standard.
1441
941
1442
942
Note: Will not include properties with access="write".
1443
943
"""
1444
944
properties = {}
1455
955
properties[name] = value
1456
956
continue
1457
957
properties[name] = type(value)(
1458
value, variant_level=value.variant_level + 1)
958
value, variant_level = value.variant_level + 1)
1459
959
return dbus.Dictionary(properties, signature="sv")
1460
960
1461
961
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1462
962
def PropertiesChanged(self, interface_name, changed_properties,
1463
963
invalidated_properties):
1465
965
standard.
1466
966
"""
1467
967
pass
1468
968
1469
969
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1470
970
out_signature="s",
1471
971
path_keyword='object_path',
1472
972
connection_keyword='connection')
1473
973
def Introspect(self, object_path, connection):
1474
974
"""Overloading of standard D-Bus method.
1475
975
1476
976
Inserts property tags and interface annotation tags.
1477
977
"""
1478
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1479
object_path,
1480
connection)
978
xmlstring = dbus.service.Object.Introspect(self, object_path,
979
connection)
1481
980
try:
1482
981
document = xml.dom.minidom.parseString(xmlstring)
1483
982
1484
983
def make_tag(document, name, prop):
1485
984
e = document.createElement("property")
1486
985
e.setAttribute("name", name)
1487
986
e.setAttribute("type", prop._dbus_signature)
1488
987
e.setAttribute("access", prop._dbus_access)
1489
988
return e
1490
989
1491
990
for if_tag in document.getElementsByTagName("interface"):
1492
991
# Add property tags
1493
992
for tag in (make_tag(document, name, prop)
1496
995
if prop._dbus_interface
1497
996
== if_tag.getAttribute("name")):
1498
997
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)
998
# Add annotation tags
999
for typ in ("method", "signal", "property"):
1000
for tag in if_tag.getElementsByTagName(typ):
1001
annots = dict()
1002
for name, prop in (self.
1003
_get_all_dbus_things(typ)):
1004
if (name == tag.getAttribute("name")
1005
and prop._dbus_interface
1006
== if_tag.getAttribute("name")):
1007
annots.update(getattr(
1008
prop, "_dbus_annotations", {}))
1009
for name, value in annots.items():
1010
ann_tag = document.createElement(
1011
"annotation")
1012
ann_tag.setAttribute("name", name)
1013
ann_tag.setAttribute("value", value)
1014
tag.appendChild(ann_tag)
1015
# Add interface annotation tags
1016
for annotation, value in dict(
1017
itertools.chain.from_iterable(
1018
annotations().items()
1019
for name, annotations
1020
in self._get_all_dbus_things("interface")
1021
if name == if_tag.getAttribute("name")
1022
)).items():
1023
ann_tag = document.createElement("annotation")
1024
ann_tag.setAttribute("name", annotation)
1025
ann_tag.setAttribute("value", value)
1026
if_tag.appendChild(ann_tag)
1515
1027
# Add the names to the return values for the
1516
1028
# "org.freedesktop.DBus.Properties" methods
1517
1029
if (if_tag.getAttribute("name")
1536
1048
return xmlstring
1537
1049
1538
1050
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
1051
def datetime_to_dbus(dt, variant_level=0):
1611
1052
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1612
1053
if dt is None:
1613
return dbus.String("", variant_level=variant_level)
1054
return dbus.String("", variant_level = variant_level)
1614
1055
return dbus.String(dt.isoformat(), variant_level=variant_level)
1615
1056
1616
1057
1619
1060
dbus.service.Object, it will add alternate D-Bus attributes with
1620
1061
interface names according to the "alt_interface_names" mapping.
1621
1062
Usage:
1622
1063
1623
1064
@alternate_dbus_interfaces({"org.example.Interface":
1624
1065
"net.example.AlternateInterface"})
1625
1066
class SampleDBusObject(dbus.service.Object):
1626
1067
@dbus.service.method("org.example.Interface")
1627
1068
def SampleDBusMethod():
1628
1069
pass
1629
1070
1630
1071
The above "SampleDBusMethod" on "SampleDBusObject" will be
1631
1072
reachable via two interfaces: "org.example.Interface" and
1632
1073
"net.example.AlternateInterface", the latter of which will have
1633
1074
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1634
1075
"true", unless "deprecate" is passed with a False value.
1635
1076
1636
1077
This works for methods and signals, and also for D-Bus properties
1637
1078
(from DBusObjectWithProperties) and interfaces (from the
1638
1079
dbus_interface_annotations decorator).
1639
1080
"""
1640
1081
1641
1082
def wrapper(cls):
1642
1083
for orig_interface_name, alt_interface_name in (
1643
1084
alt_interface_names.items()):
1658
1099
interface_names.add(alt_interface)
1659
1100
# Is this a D-Bus signal?
1660
1101
if getattr(attribute, "_dbus_is_signal", False):
1661
# Extract the original non-method undecorated
1662
# function by black magic
1663
1102
if sys.version_info.major == 2:
1103
# Extract the original non-method undecorated
1104
# function by black magic
1664
1105
nonmethod_func = (dict(
1665
1106
zip(attribute.func_code.co_freevars,
1666
1107
attribute.__closure__))
1667
1108
["func"].cell_contents)
1668
1109
else:
1669
nonmethod_func = (dict(
1670
zip(attribute.__code__.co_freevars,
1671
attribute.__closure__))
1672
["func"].cell_contents)
1110
nonmethod_func = attribute
1673
1111
# Create a new, but exactly alike, function
1674
1112
# object, and decorate it to be a new D-Bus signal
1675
1113
# with the alternate D-Bus interface name
1676
new_function = copy_function(nonmethod_func)
1114
if sys.version_info.major == 2:
1115
new_function = types.FunctionType(
1116
nonmethod_func.func_code,
1117
nonmethod_func.func_globals,
1118
nonmethod_func.func_name,
1119
nonmethod_func.func_defaults,
1120
nonmethod_func.func_closure)
1121
else:
1122
new_function = types.FunctionType(
1123
nonmethod_func.__code__,
1124
nonmethod_func.__globals__,
1125
nonmethod_func.__name__,
1126
nonmethod_func.__defaults__,
1127
nonmethod_func.__closure__)
1677
1128
new_function = (dbus.service.signal(
1678
1129
alt_interface,
1679
1130
attribute._dbus_signature)(new_function))
1683
1134
attribute._dbus_annotations)
1684
1135
except AttributeError:
1685
1136
pass
1686
1687
1137
# Define a creator of a function to call both the
1688
1138
# original and alternate functions, so both the
1689
1139
# original and alternate signals gets sent when
1692
1142
"""This function is a scope container to pass
1693
1143
func1 and func2 to the "call_both" function
1694
1144
outside of its arguments"""
1695
1696
@functools.wraps(func2)
1145
1697
1146
def call_both(*args, **kwargs):
1698
1147
"""This function will emit two D-Bus
1699
1148
signals by calling func1 and func2"""
1700
1149
func1(*args, **kwargs)
1701
1150
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
1151
1708
1152
return call_both
1709
1153
# Create the "call_both" function and add it to
1710
1154
# the class
1720
1164
alt_interface,
1721
1165
attribute._dbus_in_signature,
1722
1166
attribute._dbus_out_signature)
1723
(copy_function(attribute)))
1167
(types.FunctionType(attribute.func_code,
1168
attribute.func_globals,
1169
attribute.func_name,
1170
attribute.func_defaults,
1171
attribute.func_closure)))
1724
1172
# Copy annotations, if any
1725
1173
try:
1726
1174
attr[attrname]._dbus_annotations = dict(
1738
1186
attribute._dbus_access,
1739
1187
attribute._dbus_get_args_options
1740
1188
["byte_arrays"])
1741
(copy_function(attribute)))
1189
(types.FunctionType(
1190
attribute.func_code,
1191
attribute.func_globals,
1192
attribute.func_name,
1193
attribute.func_defaults,
1194
attribute.func_closure)))
1742
1195
# Copy annotations, if any
1743
1196
try:
1744
1197
attr[attrname]._dbus_annotations = dict(
1753
1206
# to the class.
1754
1207
attr[attrname] = (
1755
1208
dbus_interface_annotations(alt_interface)
1756
(copy_function(attribute)))
1209
(types.FunctionType(attribute.func_code,
1210
attribute.func_globals,
1211
attribute.func_name,
1212
attribute.func_defaults,
1213
attribute.func_closure)))
1757
1214
if deprecate:
1758
1215
# Deprecate all alternate interfaces
1759
iname = "_AlternateDBusNames_interface_annotation{}"
1216
iname="_AlternateDBusNames_interface_annotation{}"
1760
1217
for interface_name in interface_names:
1761
1218
1762
1219
@dbus_interface_annotations(interface_name)
1763
1220
def func(self):
1764
return {"org.freedesktop.DBus.Deprecated":
1765
"true"}
1221
return { "org.freedesktop.DBus.Deprecated":
1222
"true" }
1766
1223
# Find an unused name
1767
1224
for aname in (iname.format(i)
1768
1225
for i in itertools.count()):
1772
1229
if interface_names:
1773
1230
# Replace the class with a new subclass of it with
1774
1231
# 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)
1232
cls = type(b"{}Alternate".format(cls.__name__),
1233
(cls, ), attr)
1781
1234
return cls
1782
1235
1783
1236
return wrapper
1784
1237
1785
1238
1787
1240
"se.bsnet.fukt.Mandos"})
1788
1241
class ClientDBus(Client, DBusObjectWithProperties):
1789
1242
"""A Client class using D-Bus
1790
1243
1791
1244
Attributes:
1792
1245
dbus_object_path: dbus.ObjectPath
1793
1246
bus: dbus.SystemBus()
1794
1247
"""
1795
1248
1796
1249
runtime_expansions = (Client.runtime_expansions
1797
1250
+ ("dbus_object_path", ))
1798
1251
1799
1252
_interface = "se.recompile.Mandos.Client"
1800
1253
1801
1254
# dbus.service.Object doesn't use super(), so we can't either.
1802
1803
def __init__(self, bus=None, *args, **kwargs):
1255
1256
def __init__(self, bus = None, *args, **kwargs):
1804
1257
self.bus = bus
1805
1258
Client.__init__(self, *args, **kwargs)
1806
1259
# Only now, when this client is initialized, can it show up on
1812
1265
"/clients/" + client_object_name)
1813
1266
DBusObjectWithProperties.__init__(self, self.bus,
1814
1267
self.dbus_object_path)
1815
1268
1816
1269
def notifychangeproperty(transform_func, dbus_name,
1817
1270
type_func=lambda x: x,
1818
1271
variant_level=1,
1820
1273
_interface=_interface):
1821
1274
""" Modify a variable so that it's a property which announces
1822
1275
its changes to DBus.
1823
1276
1824
1277
transform_fun: Function that takes a value and a variant_level
1825
1278
and transforms it to a D-Bus type.
1826
1279
dbus_name: D-Bus name of the variable
1829
1282
variant_level: D-Bus variant level. Default: 1
1830
1283
"""
1831
1284
attrname = "_{}".format(dbus_name)
1832
1285
1833
1286
def setter(self, value):
1834
1287
if hasattr(self, "dbus_object_path"):
1835
1288
if (not hasattr(self, attrname) or
1842
1295
else:
1843
1296
dbus_value = transform_func(
1844
1297
type_func(value),
1845
variant_level=variant_level)
1298
variant_level = variant_level)
1846
1299
self.PropertyChanged(dbus.String(dbus_name),
1847
1300
dbus_value)
1848
1301
self.PropertiesChanged(
1849
1302
_interface,
1850
dbus.Dictionary({dbus.String(dbus_name):
1851
dbus_value}),
1303
dbus.Dictionary({ dbus.String(dbus_name):
1304
dbus_value }),
1852
1305
dbus.Array())
1853
1306
setattr(self, attrname, value)
1854
1307
1855
1308
return property(lambda self: getattr(self, attrname), setter)
1856
1309
1857
1310
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1858
1311
approvals_pending = notifychangeproperty(dbus.Boolean,
1859
1312
"ApprovalPending",
1860
type_func=bool)
1313
type_func = bool)
1861
1314
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1862
1315
last_enabled = notifychangeproperty(datetime_to_dbus,
1863
1316
"LastEnabled")
1864
1317
checker = notifychangeproperty(
1865
1318
dbus.Boolean, "CheckerRunning",
1866
type_func=lambda checker: checker is not None)
1319
type_func = lambda checker: checker is not None)
1867
1320
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1868
1321
"LastCheckedOK")
1869
1322
last_checker_status = notifychangeproperty(dbus.Int16,
1874
1327
"ApprovedByDefault")
1875
1328
approval_delay = notifychangeproperty(
1876
1329
dbus.UInt64, "ApprovalDelay",
1877
type_func=lambda td: td.total_seconds() * 1000)
1330
type_func = lambda td: td.total_seconds() * 1000)
1878
1331
approval_duration = notifychangeproperty(
1879
1332
dbus.UInt64, "ApprovalDuration",
1880
type_func=lambda td: td.total_seconds() * 1000)
1333
type_func = lambda td: td.total_seconds() * 1000)
1881
1334
host = notifychangeproperty(dbus.String, "Host")
1882
1335
timeout = notifychangeproperty(
1883
1336
dbus.UInt64, "Timeout",
1884
type_func=lambda td: td.total_seconds() * 1000)
1337
type_func = lambda td: td.total_seconds() * 1000)
1885
1338
extended_timeout = notifychangeproperty(
1886
1339
dbus.UInt64, "ExtendedTimeout",
1887
type_func=lambda td: td.total_seconds() * 1000)
1340
type_func = lambda td: td.total_seconds() * 1000)
1888
1341
interval = notifychangeproperty(
1889
1342
dbus.UInt64, "Interval",
1890
type_func=lambda td: td.total_seconds() * 1000)
1343
type_func = lambda td: td.total_seconds() * 1000)
1891
1344
checker_command = notifychangeproperty(dbus.String, "Checker")
1892
1345
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1893
1346
invalidate_only=True)
1894
1347
1895
1348
del notifychangeproperty
1896
1349
1897
1350
def __del__(self, *args, **kwargs):
1898
1351
try:
1899
1352
self.remove_from_connection()
1902
1355
if hasattr(DBusObjectWithProperties, "__del__"):
1903
1356
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1904
1357
Client.__del__(self, *args, **kwargs)
1905
1358
1906
1359
def checker_callback(self, source, condition,
1907
1360
connection, command, *args, **kwargs):
1908
1361
ret = Client.checker_callback(self, source, condition,
1912
1365
if exitstatus >= 0:
1913
1366
# Emit D-Bus signal
1914
1367
self.CheckerCompleted(dbus.Int16(exitstatus),
1915
# This is specific to GNU libC
1916
dbus.Int64(exitstatus << 8),
1368
dbus.Int64(0),
1917
1369
dbus.String(command))
1918
1370
else:
1919
1371
# Emit D-Bus signal
1920
1372
self.CheckerCompleted(dbus.Int16(-1),
1921
1373
dbus.Int64(
1922
# This is specific to GNU libC
1923
(exitstatus << 8)
1924
| self.last_checker_signal),
1374
self.last_checker_signal),
1925
1375
dbus.String(command))
1926
1376
return ret
1927
1377
1928
1378
def start_checker(self, *args, **kwargs):
1929
1379
old_checker_pid = getattr(self.checker, "pid", None)
1930
1380
r = Client.start_checker(self, *args, **kwargs)
1934
1384
# Emit D-Bus signal
1935
1385
self.CheckerStarted(self.current_checker_command)
1936
1386
return r
1937
1387
1938
1388
def _reset_approved(self):
1939
1389
self.approved = None
1940
1390
return False
1941
1391
1942
1392
def approve(self, value=True):
1943
1393
self.approved = value
1944
GLib.timeout_add(int(self.approval_duration.total_seconds()
1945
* 1000), self._reset_approved)
1394
gobject.timeout_add(int(self.approval_duration.total_seconds()
1395
* 1000), self._reset_approved)
1946
1396
self.send_changedstate()
1947
1948
# D-Bus methods, signals & properties
1949
1950
# Interfaces
1951
1952
# Signals
1953
1397
1398
## D-Bus methods, signals & properties
1399
1400
## Interfaces
1401
1402
## Signals
1403
1954
1404
# CheckerCompleted - signal
1955
1405
@dbus.service.signal(_interface, signature="nxs")
1956
1406
def CheckerCompleted(self, exitcode, waitstatus, command):
1957
1407
"D-Bus signal"
1958
1408
pass
1959
1409
1960
1410
# CheckerStarted - signal
1961
1411
@dbus.service.signal(_interface, signature="s")
1962
1412
def CheckerStarted(self, command):
1963
1413
"D-Bus signal"
1964
1414
pass
1965
1415
1966
1416
# PropertyChanged - signal
1967
1417
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1968
1418
@dbus.service.signal(_interface, signature="sv")
1969
1419
def PropertyChanged(self, property, value):
1970
1420
"D-Bus signal"
1971
1421
pass
1972
1422
1973
1423
# GotSecret - signal
1974
1424
@dbus.service.signal(_interface)
1975
1425
def GotSecret(self):
1978
1428
server to mandos-client
1979
1429
"""
1980
1430
pass
1981
1431
1982
1432
# Rejected - signal
1983
1433
@dbus.service.signal(_interface, signature="s")
1984
1434
def Rejected(self, reason):
1985
1435
"D-Bus signal"
1986
1436
pass
1987
1437
1988
1438
# NeedApproval - signal
1989
1439
@dbus.service.signal(_interface, signature="tb")
1990
1440
def NeedApproval(self, timeout, default):
1991
1441
"D-Bus signal"
1992
1442
return self.need_approval()
1993
1994
# Methods
1995
1443
1444
## Methods
1445
1996
1446
# Approve - method
1997
1447
@dbus.service.method(_interface, in_signature="b")
1998
1448
def Approve(self, value):
1999
1449
self.approve(value)
2000
1450
2001
1451
# CheckedOK - method
2002
1452
@dbus.service.method(_interface)
2003
1453
def CheckedOK(self):
2004
1454
self.checked_ok()
2005
1455
2006
1456
# Enable - method
2007
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2008
1457
@dbus.service.method(_interface)
2009
1458
def Enable(self):
2010
1459
"D-Bus method"
2011
1460
self.enable()
2012
1461
2013
1462
# StartChecker - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2015
1463
@dbus.service.method(_interface)
2016
1464
def StartChecker(self):
2017
1465
"D-Bus method"
2018
1466
self.start_checker()
2019
1467
2020
1468
# Disable - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2022
1469
@dbus.service.method(_interface)
2023
1470
def Disable(self):
2024
1471
"D-Bus method"
2025
1472
self.disable()
2026
1473
2027
1474
# StopChecker - method
2028
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2029
1475
@dbus.service.method(_interface)
2030
1476
def StopChecker(self):
2031
1477
self.stop_checker()
2032
2033
# Properties
2034
1478
1479
## Properties
1480
2035
1481
# ApprovalPending - property
2036
1482
@dbus_service_property(_interface, signature="b", access="read")
2037
1483
def ApprovalPending_dbus_property(self):
2038
1484
return dbus.Boolean(bool(self.approvals_pending))
2039
1485
2040
1486
# ApprovedByDefault - property
2041
1487
@dbus_service_property(_interface,
2042
1488
signature="b",
2045
1491
if value is None: # get
2046
1492
return dbus.Boolean(self.approved_by_default)
2047
1493
self.approved_by_default = bool(value)
2048
1494
2049
1495
# ApprovalDelay - property
2050
1496
@dbus_service_property(_interface,
2051
1497
signature="t",
2055
1501
return dbus.UInt64(self.approval_delay.total_seconds()
2056
1502
* 1000)
2057
1503
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2058
1504
2059
1505
# ApprovalDuration - property
2060
1506
@dbus_service_property(_interface,
2061
1507
signature="t",
2065
1511
return dbus.UInt64(self.approval_duration.total_seconds()
2066
1512
* 1000)
2067
1513
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2068
1514
2069
1515
# Name - property
2070
@dbus_annotations(
2071
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2072
1516
@dbus_service_property(_interface, signature="s", access="read")
2073
1517
def Name_dbus_property(self):
2074
1518
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
1519
2083
1520
# Fingerprint - property
2084
@dbus_annotations(
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
1521
@dbus_service_property(_interface, signature="s", access="read")
2087
1522
def Fingerprint_dbus_property(self):
2088
1523
return dbus.String(self.fingerprint)
2089
1524
2090
1525
# Host - property
2091
1526
@dbus_service_property(_interface,
2092
1527
signature="s",
2095
1530
if value is None: # get
2096
1531
return dbus.String(self.host)
2097
1532
self.host = str(value)
2098
1533
2099
1534
# Created - property
2100
@dbus_annotations(
2101
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2102
1535
@dbus_service_property(_interface, signature="s", access="read")
2103
1536
def Created_dbus_property(self):
2104
1537
return datetime_to_dbus(self.created)
2105
1538
2106
1539
# LastEnabled - property
2107
1540
@dbus_service_property(_interface, signature="s", access="read")
2108
1541
def LastEnabled_dbus_property(self):
2109
1542
return datetime_to_dbus(self.last_enabled)
2110
1543
2111
1544
# Enabled - property
2112
1545
@dbus_service_property(_interface,
2113
1546
signature="b",
2119
1552
self.enable()
2120
1553
else:
2121
1554
self.disable()
2122
1555
2123
1556
# LastCheckedOK - property
2124
1557
@dbus_service_property(_interface,
2125
1558
signature="s",
2129
1562
self.checked_ok()
2130
1563
return
2131
1564
return datetime_to_dbus(self.last_checked_ok)
2132
1565
2133
1566
# LastCheckerStatus - property
2134
1567
@dbus_service_property(_interface, signature="n", access="read")
2135
1568
def LastCheckerStatus_dbus_property(self):
2136
1569
return dbus.Int16(self.last_checker_status)
2137
1570
2138
1571
# Expires - property
2139
1572
@dbus_service_property(_interface, signature="s", access="read")
2140
1573
def Expires_dbus_property(self):
2141
1574
return datetime_to_dbus(self.expires)
2142
1575
2143
1576
# LastApprovalRequest - property
2144
1577
@dbus_service_property(_interface, signature="s", access="read")
2145
1578
def LastApprovalRequest_dbus_property(self):
2146
1579
return datetime_to_dbus(self.last_approval_request)
2147
1580
2148
1581
# Timeout - property
2149
1582
@dbus_service_property(_interface,
2150
1583
signature="t",
2165
1598
if (getattr(self, "disable_initiator_tag", None)
2166
1599
is None):
2167
1600
return
2168
GLib.source_remove(self.disable_initiator_tag)
2169
self.disable_initiator_tag = GLib.timeout_add(
1601
gobject.source_remove(self.disable_initiator_tag)
1602
self.disable_initiator_tag = gobject.timeout_add(
2170
1603
int((self.expires - now).total_seconds() * 1000),
2171
1604
self.disable)
2172
1605
2173
1606
# ExtendedTimeout - property
2174
1607
@dbus_service_property(_interface,
2175
1608
signature="t",
2179
1612
return dbus.UInt64(self.extended_timeout.total_seconds()
2180
1613
* 1000)
2181
1614
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2182
1615
2183
1616
# Interval - property
2184
1617
@dbus_service_property(_interface,
2185
1618
signature="t",
2192
1625
return
2193
1626
if self.enabled:
2194
1627
# Reschedule checker run
2195
GLib.source_remove(self.checker_initiator_tag)
2196
self.checker_initiator_tag = GLib.timeout_add(
1628
gobject.source_remove(self.checker_initiator_tag)
1629
self.checker_initiator_tag = gobject.timeout_add(
2197
1630
value, self.start_checker)
2198
self.start_checker() # Start one now, too
2199
1631
self.start_checker() # Start one now, too
1632
2200
1633
# Checker - property
2201
1634
@dbus_service_property(_interface,
2202
1635
signature="s",
2205
1638
if value is None: # get
2206
1639
return dbus.String(self.checker_command)
2207
1640
self.checker_command = str(value)
2208
1641
2209
1642
# CheckerRunning - property
2210
1643
@dbus_service_property(_interface,
2211
1644
signature="b",
2217
1650
self.start_checker()
2218
1651
else:
2219
1652
self.stop_checker()
2220
1653
2221
1654
# ObjectPath - property
2222
@dbus_annotations(
2223
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2224
"org.freedesktop.DBus.Deprecated": "true"})
2225
1655
@dbus_service_property(_interface, signature="o", access="read")
2226
1656
def ObjectPath_dbus_property(self):
2227
return self.dbus_object_path # is already a dbus.ObjectPath
2228
1657
return self.dbus_object_path # is already a dbus.ObjectPath
1658
2229
1659
# Secret = property
2230
@dbus_annotations(
2231
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2232
"invalidates"})
2233
1660
@dbus_service_property(_interface,
2234
1661
signature="ay",
2235
1662
access="write",
2236
1663
byte_arrays=True)
2237
1664
def Secret_dbus_property(self, value):
2238
1665
self.secret = bytes(value)
2239
1666
2240
1667
del _interface
2241
1668
2242
1669
2243
class ProxyClient:
2244
def __init__(self, child_pipe, key_id, fpr, address):
1670
class ProxyClient(object):
1671
def __init__(self, child_pipe, fpr, address):
2245
1672
self._pipe = child_pipe
2246
self._pipe.send(('init', key_id, fpr, address))
1673
self._pipe.send(('init', fpr, address))
2247
1674
if not self._pipe.recv():
2248
raise KeyError(key_id or fpr)
2249
1675
raise KeyError(fpr)
1676
2250
1677
def __getattribute__(self, name):
2251
1678
if name == '_pipe':
2252
1679
return super(ProxyClient, self).__getattribute__(name)
2255
1682
if data[0] == 'data':
2256
1683
return data[1]
2257
1684
if data[0] == 'function':
2258
1685
2259
1686
def func(*args, **kwargs):
2260
1687
self._pipe.send(('funcall', name, args, kwargs))
2261
1688
return self._pipe.recv()[1]
2262
1689
2263
1690
return func
2264
1691
2265
1692
def __setattr__(self, name, value):
2266
1693
if name == '_pipe':
2267
1694
return super(ProxyClient, self).__setattr__(name, value)
2270
1697
2271
1698
class ClientHandler(socketserver.BaseRequestHandler, object):
2272
1699
"""A class to handle client connections.
2273
1700
2274
1701
Instantiated once for each connection to handle it.
2275
1702
Note: This will run in its own forked process."""
2276
1703
2277
1704
def handle(self):
2278
1705
with contextlib.closing(self.server.child_pipe) as child_pipe:
2279
1706
logger.info("TCP connection from: %s",
2280
1707
str(self.client_address))
2281
1708
logger.debug("Pipe FD: %d",
2282
1709
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"))
1710
1711
session = gnutls.connection.ClientSession(
1712
self.request, gnutls.connection .X509Credentials())
1713
1714
# Note: gnutls.connection.X509Credentials is really a
1715
# generic GnuTLS certificate credentials object so long as
1716
# no X.509 keys are added to it. Therefore, we can use it
1717
# here despite using OpenPGP certificates.
1718
1719
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1720
# "+AES-256-CBC", "+SHA1",
1721
# "+COMP-NULL", "+CTYPE-OPENPGP",
1722
# "+DHE-DSS"))
2290
1723
# Use a fallback default, since this MUST be set.
2291
1724
priority = self.server.gnutls_priority
2292
1725
if priority is None:
2293
1726
priority = "NORMAL"
2294
gnutls.priority_set_direct(session._c_object,
2295
priority.encode("utf-8"),
2296
None)
2297
1727
gnutls.library.functions.gnutls_priority_set_direct(
1728
session._c_object, priority, None)
1729
2298
1730
# Start communication using the Mandos protocol
2299
1731
# Get protocol number
2300
1732
line = self.request.makefile().readline()
2305
1737
except (ValueError, IndexError, RuntimeError) as error:
2306
1738
logger.error("Unknown protocol version: %s", error)
2307
1739
return
2308
1740
2309
1741
# Start GnuTLS connection
2310
1742
try:
2311
1743
session.handshake()
2312
except gnutls.Error as error:
1744
except gnutls.errors.GNUTLSError as error:
2313
1745
logger.warning("Handshake failed: %s", error)
2314
1746
# Do not run session.bye() here: the session is not
2315
1747
# established. Just abandon the request.
2316
1748
return
2317
1749
logger.debug("Handshake succeeded")
2318
1750
2319
1751
approval_required = False
2320
1752
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,
1753
try:
1754
fpr = self.fingerprint(
1755
self.peer_certificate(session))
1756
except (TypeError,
1757
gnutls.errors.GNUTLSError) as error:
1758
logger.warning("Bad certificate: %s", error)
1759
return
1760
logger.debug("Fingerprint: %s", fpr)
1761
1762
try:
1763
client = ProxyClient(child_pipe, fpr,
2343
1764
self.client_address)
2344
1765
except KeyError:
2345
1766
return
2346
1767
2347
1768
if client.approval_delay:
2348
1769
delay = client.approval_delay
2349
1770
client.approvals_pending += 1
2350
1771
approval_required = True
2351
1772
2352
1773
while True:
2353
1774
if not client.enabled:
2354
1775
logger.info("Client %s is disabled",
2357
1778
# Emit D-Bus signal
2358
1779
client.Rejected("Disabled")
2359
1780
return
2360
1781
2361
1782
if client.approved or not client.approval_delay:
2362
# We are approved or approval is disabled
1783
#We are approved or approval is disabled
2363
1784
break
2364
1785
elif client.approved is None:
2365
1786
logger.info("Client %s needs approval",
2376
1797
# Emit D-Bus signal
2377
1798
client.Rejected("Denied")
2378
1799
return
2379
2380
# wait until timeout or approved
1800
1801
#wait until timeout or approved
2381
1802
time = datetime.datetime.now()
2382
1803
client.changedstate.acquire()
2383
1804
client.changedstate.wait(delay.total_seconds())
2396
1817
break
2397
1818
else:
2398
1819
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
1820
1821
sent_size = 0
1822
while sent_size < len(client.secret):
1823
try:
1824
sent = session.send(client.secret[sent_size:])
1825
except gnutls.errors.GNUTLSError as error:
1826
logger.warning("gnutls send failed",
1827
exc_info=error)
1828
return
1829
logger.debug("Sent: %d, remaining: %d", sent,
1830
len(client.secret) - (sent_size
1831
+ sent))
1832
sent_size += sent
1833
2407
1834
logger.info("Sending secret to %s", client.name)
2408
1835
# bump the timeout using extended_timeout
2409
1836
client.bump_timeout(client.extended_timeout)
2410
1837
if self.server.use_dbus:
2411
1838
# Emit D-Bus signal
2412
1839
client.GotSecret()
2413
1840
2414
1841
finally:
2415
1842
if approval_required:
2416
1843
client.approvals_pending -= 1
2417
1844
try:
2418
1845
session.bye()
2419
except gnutls.Error as error:
1846
except gnutls.errors.GNUTLSError as error:
2420
1847
logger.warning("GnuTLS bye failed",
2421
1848
exc_info=error)
2422
1849
2423
1850
@staticmethod
2424
1851
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""
1852
"Return the peer's OpenPGP certificate as a bytestring"
1853
# If not an OpenPGP certificate...
1854
if (gnutls.library.functions.gnutls_certificate_type_get(
1855
session._c_object)
1856
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1857
# ...do the normal thing
1858
return session.peer_certificate
2441
1859
list_size = ctypes.c_uint(1)
2442
cert_list = (gnutls.certificate_get_peers
1860
cert_list = (gnutls.library.functions
1861
.gnutls_certificate_get_peers
2443
1862
(session._c_object, ctypes.byref(list_size)))
2444
1863
if not bool(cert_list) and list_size.value != 0:
2445
raise gnutls.Error("error getting peer certificate")
1864
raise gnutls.errors.GNUTLSError("error getting peer"
1865
" certificate")
2446
1866
if list_size.value == 0:
2447
1867
return None
2448
1868
cert = cert_list[0]
2449
1869
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
1870
2485
1871
@staticmethod
2486
1872
def fingerprint(openpgp):
2487
1873
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2488
1874
# New GnuTLS "datum" with the OpenPGP public key
2489
datum = gnutls.datum_t(
1875
datum = gnutls.library.types.gnutls_datum_t(
2490
1876
ctypes.cast(ctypes.c_char_p(openpgp),
2491
1877
ctypes.POINTER(ctypes.c_ubyte)),
2492
1878
ctypes.c_uint(len(openpgp)))
2493
1879
# New empty GnuTLS certificate
2494
crt = gnutls.openpgp_crt_t()
2495
gnutls.openpgp_crt_init(ctypes.byref(crt))
1880
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1881
gnutls.library.functions.gnutls_openpgp_crt_init(
1882
ctypes.byref(crt))
2496
1883
# Import the OpenPGP public key into the certificate
2497
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2498
gnutls.OPENPGP_FMT_RAW)
1884
gnutls.library.functions.gnutls_openpgp_crt_import(
1885
crt, ctypes.byref(datum),
1886
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
2499
1887
# Verify the self signature in the key
2500
1888
crtverify = ctypes.c_uint()
2501
gnutls.openpgp_crt_verify_self(crt, 0,
2502
ctypes.byref(crtverify))
1889
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1890
crt, 0, ctypes.byref(crtverify))
2503
1891
if crtverify.value != 0:
2504
gnutls.openpgp_crt_deinit(crt)
2505
raise gnutls.CertificateSecurityError(code
2506
=crtverify.value)
1892
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1893
raise gnutls.errors.CertificateSecurityError(
1894
"Verify failed")
2507
1895
# New buffer for the fingerprint
2508
1896
buf = ctypes.create_string_buffer(20)
2509
1897
buf_len = ctypes.c_size_t()
2510
1898
# Get the fingerprint from the certificate into the buffer
2511
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2512
ctypes.byref(buf_len))
1899
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1900
crt, ctypes.byref(buf), ctypes.byref(buf_len))
2513
1901
# Deinit the certificate
2514
gnutls.openpgp_crt_deinit(crt)
1902
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2515
1903
# Convert the buffer to a Python bytestring
2516
1904
fpr = ctypes.string_at(buf, buf_len.value)
2517
1905
# Convert the bytestring to hexadecimal notation
2519
1907
return hex_fpr
2520
1908
2521
1909
2522
class MultiprocessingMixIn:
1910
class MultiprocessingMixIn(object):
2523
1911
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2524
1912
2525
1913
def sub_process_main(self, request, address):
2526
1914
try:
2527
1915
self.finish_request(request, address)
2528
1916
except Exception:
2529
1917
self.handle_error(request, address)
2530
1918
self.close_request(request)
2531
1919
2532
1920
def process_request(self, request, address):
2533
1921
"""Start a new process to process the request."""
2534
proc = multiprocessing.Process(target=self.sub_process_main,
2535
args=(request, address))
1922
proc = multiprocessing.Process(target = self.sub_process_main,
1923
args = (request, address))
2536
1924
proc.start()
2537
1925
return proc
2538
1926
2539
1927
2540
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1928
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2541
1929
""" adds a pipe to the MixIn """
2542
1930
2543
1931
def process_request(self, request, client_address):
2544
1932
"""Overrides and wraps the original process_request().
2545
1933
2546
1934
This function creates a new pipe in self.pipe
2547
1935
"""
2548
1936
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2549
1937
2550
1938
proc = MultiprocessingMixIn.process_request(self, request,
2551
1939
client_address)
2552
1940
self.child_pipe.close()
2553
1941
self.add_pipe(parent_pipe, proc)
2554
1942
2555
1943
def add_pipe(self, parent_pipe, proc):
2556
1944
"""Dummy function; override as necessary"""
2557
1945
raise NotImplementedError()
2558
1946
2559
1947
2560
1948
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2561
socketserver.TCPServer):
1949
socketserver.TCPServer, object):
2562
1950
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2563
1951
2564
1952
Attributes:
2565
1953
enabled: Boolean; whether this server is activated yet
2566
1954
interface: None or a network interface name (string)
2567
1955
use_ipv6: Boolean; to use IPv6 or not
2568
1956
"""
2569
1957
2570
1958
def __init__(self, server_address, RequestHandlerClass,
2571
1959
interface=None,
2572
1960
use_ipv6=True,
2582
1970
self.socketfd = socketfd
2583
1971
# Save the original socket.socket() function
2584
1972
self.socket_socket = socket.socket
2585
2586
1973
# To implement --socket, we monkey patch socket.socket.
2587
#
1974
#
2588
1975
# (When socketserver.TCPServer is a new-style class, we
2589
1976
# could make self.socket into a property instead of monkey
2590
1977
# patching socket.socket.)
2591
#
1978
#
2592
1979
# Create a one-time-only replacement for socket.socket()
2593
1980
@functools.wraps(socket.socket)
2594
1981
def socket_wrapper(*args, **kwargs):
2606
1993
# socket_wrapper(), if socketfd was set.
2607
1994
socketserver.TCPServer.__init__(self, server_address,
2608
1995
RequestHandlerClass)
2609
1996
2610
1997
def server_bind(self):
2611
1998
"""This overrides the normal server_bind() function
2612
1999
to bind to an interface if one was specified, and also NOT to
2613
2000
bind to an address or port if they were not specified."""
2614
global SO_BINDTODEVICE
2615
2001
if self.interface is not None:
2616
2002
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
2003
logger.error("SO_BINDTODEVICE does not exist;"
2004
" cannot bind to interface %s",
2005
self.interface)
2006
else:
2007
try:
2008
self.socket.setsockopt(
2009
socket.SOL_SOCKET, SO_BINDTODEVICE,
2010
(self.interface + "\0").encode("utf-8"))
2011
except socket.error as error:
2012
if error.errno == errno.EPERM:
2013
logger.error("No permission to bind to"
2014
" interface %s", self.interface)
2015
elif error.errno == errno.ENOPROTOOPT:
2016
logger.error("SO_BINDTODEVICE not available;"
2017
" cannot bind to interface %s",
2018
self.interface)
2019
elif error.errno == errno.ENODEV:
2020
logger.error("Interface %s does not exist,"
2021
" cannot bind", self.interface)
2022
else:
2023
raise
2638
2024
# Only bind(2) the socket if we really need to.
2639
2025
if self.server_address[0] or self.server_address[1]:
2640
if self.server_address[1]:
2641
self.allow_reuse_address = True
2642
2026
if not self.server_address[0]:
2643
2027
if self.address_family == socket.AF_INET6:
2644
any_address = "::" # in6addr_any
2028
any_address = "::" # in6addr_any
2645
2029
else:
2646
any_address = "0.0.0.0" # INADDR_ANY
2030
any_address = "0.0.0.0" # INADDR_ANY
2647
2031
self.server_address = (any_address,
2648
2032
self.server_address[1])
2649
2033
elif not self.server_address[1]:
2659
2043
2660
2044
class MandosServer(IPv6_TCPServer):
2661
2045
"""Mandos server.
2662
2046
2663
2047
Attributes:
2664
2048
clients: set of Client objects
2665
2049
gnutls_priority GnuTLS priority string
2666
2050
use_dbus: Boolean; to emit D-Bus signals or not
2667
2668
Assumes a GLib.MainLoop event loop.
2051
2052
Assumes a gobject.MainLoop event loop.
2669
2053
"""
2670
2054
2671
2055
def __init__(self, server_address, RequestHandlerClass,
2672
2056
interface=None,
2673
2057
use_ipv6=True,
2683
2067
self.gnutls_priority = gnutls_priority
2684
2068
IPv6_TCPServer.__init__(self, server_address,
2685
2069
RequestHandlerClass,
2686
interface=interface,
2687
use_ipv6=use_ipv6,
2688
socketfd=socketfd)
2689
2070
interface = interface,
2071
use_ipv6 = use_ipv6,
2072
socketfd = socketfd)
2073
2690
2074
def server_activate(self):
2691
2075
if self.enabled:
2692
2076
return socketserver.TCPServer.server_activate(self)
2693
2077
2694
2078
def enable(self):
2695
2079
self.enabled = True
2696
2080
2697
2081
def add_pipe(self, parent_pipe, proc):
2698
2082
# 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,
2083
gobject.io_add_watch(
2084
parent_pipe.fileno(),
2085
gobject.IO_IN | gobject.IO_HUP,
2702
2086
functools.partial(self.handle_ipc,
2703
parent_pipe=parent_pipe,
2704
proc=proc))
2705
2087
parent_pipe = parent_pipe,
2088
proc = proc))
2089
2706
2090
def handle_ipc(self, source, condition,
2707
2091
parent_pipe=None,
2708
proc=None,
2092
proc = None,
2709
2093
client_object=None):
2710
2094
# error, or the other end of multiprocessing.Pipe has closed
2711
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2095
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2712
2096
# Wait for other process to exit
2713
2097
proc.join()
2714
2098
return False
2715
2099
2716
2100
# Read a request from the child
2717
2101
request = parent_pipe.recv()
2718
2102
command = request[0]
2719
2103
2720
2104
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:
2105
fpr = request[1]
2106
address = request[2]
2107
2108
for c in self.clients.itervalues():
2109
if c.fingerprint == fpr:
2732
2110
client = c
2733
2111
break
2734
2112
else:
2735
logger.info("Client not found for key ID: %s, address"
2736
": %s", key_id or fpr, address)
2113
logger.info("Client not found for fingerprint: %s, ad"
2114
"dress: %s", fpr, address)
2737
2115
if self.use_dbus:
2738
2116
# Emit D-Bus signal
2739
mandos_dbus_service.ClientNotFound(key_id or fpr,
2117
mandos_dbus_service.ClientNotFound(fpr,
2740
2118
address[0])
2741
2119
parent_pipe.send(False)
2742
2120
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,
2121
2122
gobject.io_add_watch(
2123
parent_pipe.fileno(),
2124
gobject.IO_IN | gobject.IO_HUP,
2747
2125
functools.partial(self.handle_ipc,
2748
parent_pipe=parent_pipe,
2749
proc=proc,
2750
client_object=client))
2126
parent_pipe = parent_pipe,
2127
proc = proc,
2128
client_object = client))
2751
2129
parent_pipe.send(True)
2752
2130
# remove the old hook in favor of the new above hook on
2753
2131
# same fileno
2756
2134
funcname = request[1]
2757
2135
args = request[2]
2758
2136
kwargs = request[3]
2759
2137
2760
2138
parent_pipe.send(('data', getattr(client_object,
2761
2139
funcname)(*args,
2762
2140
**kwargs)))
2763
2141
2764
2142
if command == 'getattr':
2765
2143
attrname = request[1]
2766
2144
if isinstance(client_object.__getattribute__(attrname),
2767
collections.abc.Callable):
2145
collections.Callable):
2768
2146
parent_pipe.send(('function', ))
2769
2147
else:
2770
2148
parent_pipe.send((
2771
2149
'data', client_object.__getattribute__(attrname)))
2772
2150
2773
2151
if command == 'setattr':
2774
2152
attrname = request[1]
2775
2153
value = request[2]
2776
2154
setattr(client_object, attrname, value)
2777
2155
2778
2156
return True
2779
2157
2780
2158
2781
2159
def rfc3339_duration_to_delta(duration):
2782
2160
"""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
2161
2162
>>> rfc3339_duration_to_delta("P7D")
2163
datetime.timedelta(7)
2164
>>> rfc3339_duration_to_delta("PT60S")
2165
datetime.timedelta(0, 60)
2166
>>> rfc3339_duration_to_delta("PT60M")
2167
datetime.timedelta(0, 3600)
2168
>>> rfc3339_duration_to_delta("PT24H")
2169
datetime.timedelta(1)
2170
>>> rfc3339_duration_to_delta("P1W")
2171
datetime.timedelta(7)
2172
>>> rfc3339_duration_to_delta("PT5M30S")
2173
datetime.timedelta(0, 330)
2174
>>> rfc3339_duration_to_delta("P1DT3M20S")
2175
datetime.timedelta(1, 200)
2798
2176
"""
2799
2177
2800
2178
# Parsing an RFC 3339 duration with regular expressions is not
2801
2179
# possible - there would have to be multiple places for the same
2802
2180
# values, like seconds. The current code, while more esoteric, is
2803
2181
# cleaner without depending on a parsing library. If Python had a
2804
2182
# built-in library for parsing we would use it, but we'd like to
2805
2183
# avoid excessive use of external libraries.
2806
2184
2807
2185
# New type for defining tokens, syntax, and semantics all-in-one
2808
2186
Token = collections.namedtuple("Token", (
2809
2187
"regexp", # To match token; if "value" is not None, must have
2842
2220
frozenset((token_year, token_month,
2843
2221
token_day, token_time,
2844
2222
token_week)))
2845
# Define starting values:
2846
# Value so far
2847
value = datetime.timedelta()
2223
# Define starting values
2224
value = datetime.timedelta() # Value so far
2848
2225
found_token = None
2849
# Following valid tokens
2850
followers = frozenset((token_duration, ))
2851
# String left to parse
2852
s = duration
2226
followers = frozenset((token_duration, )) # Following valid tokens
2227
s = duration # String left to parse
2853
2228
# Loop until end token is found
2854
2229
while found_token is not token_end:
2855
2230
# Search for any currently valid tokens
2879
2254
2880
2255
def string_to_delta(interval):
2881
2256
"""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
2257
2258
>>> string_to_delta('7d')
2259
datetime.timedelta(7)
2260
>>> string_to_delta('60s')
2261
datetime.timedelta(0, 60)
2262
>>> string_to_delta('60m')
2263
datetime.timedelta(0, 3600)
2264
>>> string_to_delta('24h')
2265
datetime.timedelta(1)
2266
>>> string_to_delta('1w')
2267
datetime.timedelta(7)
2268
>>> string_to_delta('5m 30s')
2269
datetime.timedelta(0, 330)
2895
2270
"""
2896
2271
2897
2272
try:
2898
2273
return rfc3339_duration_to_delta(interval)
2899
2274
except ValueError:
2900
2275
pass
2901
2276
2902
2277
timevalue = datetime.timedelta(0)
2903
2278
for s in interval.split():
2904
2279
try:
2922
2297
return timevalue
2923
2298
2924
2299
2925
def daemon(nochdir=False, noclose=False):
2300
def daemon(nochdir = False, noclose = False):
2926
2301
"""See daemon(3). Standard BSD Unix function.
2927
2302
2928
2303
This should really exist as os.daemon, but it doesn't (yet)."""
2929
2304
if os.fork():
2930
2305
sys.exit()
2948
2323
2949
2324
2950
2325
def main():
2951
2326
2952
2327
##################################################################
2953
2328
# Parsing of options, both command line and config file
2954
2329
2955
2330
parser = argparse.ArgumentParser()
2956
2331
parser.add_argument("-v", "--version", action="version",
2957
version="%(prog)s {}".format(version),
2332
version = "%(prog)s {}".format(version),
2958
2333
help="show version number and exit")
2959
2334
parser.add_argument("-i", "--interface", metavar="IF",
2960
2335
help="Bind to interface IF")
2996
2371
parser.add_argument("--no-zeroconf", action="store_false",
2997
2372
dest="zeroconf", help="Do not use Zeroconf",
2998
2373
default=None)
2999
2374
3000
2375
options = parser.parse_args()
3001
2376
2377
if options.check:
2378
import doctest
2379
fail_count, test_count = doctest.testmod()
2380
sys.exit(os.EX_OK if fail_count == 0 else 1)
2381
3002
2382
# 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
2383
server_defaults = { "interface": "",
2384
"address": "",
2385
"port": "",
2386
"debug": "False",
2387
"priority":
2388
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2389
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2390
"servicename": "Mandos",
2391
"use_dbus": "True",
2392
"use_ipv6": "True",
2393
"debuglevel": "",
2394
"restore": "True",
2395
"socket": "",
2396
"statedir": "/var/lib/mandos",
2397
"foreground": "False",
2398
"zeroconf": "True",
2399
}
2400
3026
2401
# Parse config file for server-global settings
3027
server_config = configparser.ConfigParser(server_defaults)
2402
server_config = configparser.SafeConfigParser(server_defaults)
3028
2403
del server_defaults
3029
2404
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3030
# Convert the ConfigParser object to a dict
2405
# Convert the SafeConfigParser object to a dict
3031
2406
server_settings = server_config.defaults()
3032
2407
# Use the appropriate methods on the non-string config options
3033
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3034
"foreground", "zeroconf"):
2408
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3035
2409
server_settings[option] = server_config.getboolean("DEFAULT",
3036
2410
option)
3037
2411
if server_settings["port"]:
3047
2421
server_settings["socket"] = os.dup(server_settings
3048
2422
["socket"])
3049
2423
del server_config
3050
2424
3051
2425
# Override the settings from the config file with command line
3052
2426
# options, if set.
3053
2427
for option in ("interface", "address", "port", "debug",
3071
2445
if server_settings["debug"]:
3072
2446
server_settings["foreground"] = True
3073
2447
# Now we have our good server settings in "server_settings"
3074
2448
3075
2449
##################################################################
3076
2450
3077
2451
if (not server_settings["zeroconf"]
3078
2452
and not (server_settings["port"]
3079
2453
or server_settings["socket"] != "")):
3080
2454
parser.error("Needs port or socket to work without Zeroconf")
3081
2455
3082
2456
# For convenience
3083
2457
debug = server_settings["debug"]
3084
2458
debuglevel = server_settings["debuglevel"]
3088
2462
stored_state_file)
3089
2463
foreground = server_settings["foreground"]
3090
2464
zeroconf = server_settings["zeroconf"]
3091
2465
3092
2466
if debug:
3093
2467
initlogger(debug, logging.DEBUG)
3094
2468
else:
3097
2471
else:
3098
2472
level = getattr(logging, debuglevel.upper())
3099
2473
initlogger(debug, level)
3100
2474
3101
2475
if server_settings["servicename"] != "Mandos":
3102
2476
syslogger.setFormatter(
3103
2477
logging.Formatter('Mandos ({}) [%(process)d]:'
3104
2478
' %(levelname)s: %(message)s'.format(
3105
2479
server_settings["servicename"])))
3106
2480
3107
2481
# Parse config file with clients
3108
client_config = configparser.ConfigParser(Client.client_defaults)
2482
client_config = configparser.SafeConfigParser(Client
2483
.client_defaults)
3109
2484
client_config.read(os.path.join(server_settings["configdir"],
3110
2485
"clients.conf"))
3111
2486
3112
2487
global mandos_dbus_service
3113
2488
mandos_dbus_service = None
3114
2489
3115
2490
socketfd = None
3116
2491
if server_settings["socket"] != "":
3117
2492
socketfd = server_settings["socket"]
3133
2508
except IOError as e:
3134
2509
logger.error("Could not open file %r", pidfilename,
3135
2510
exc_info=e)
3136
3137
for name, group in (("_mandos", "_mandos"),
3138
("mandos", "mandos"),
3139
("nobody", "nogroup")):
2511
2512
for name in ("_mandos", "mandos", "nobody"):
3140
2513
try:
3141
2514
uid = pwd.getpwnam(name).pw_uid
3142
gid = pwd.getpwnam(group).pw_gid
2515
gid = pwd.getpwnam(name).pw_gid
3143
2516
break
3144
2517
except KeyError:
3145
2518
continue
3149
2522
try:
3150
2523
os.setgid(gid)
3151
2524
os.setuid(uid)
3152
if debug:
3153
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3154
gid))
3155
2525
except OSError as error:
3156
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3157
.format(uid, gid, os.strerror(error.errno)))
3158
2526
if error.errno != errno.EPERM:
3159
2527
raise
3160
2528
3161
2529
if debug:
3162
2530
# Enable all possible GnuTLS debugging
3163
2531
3164
2532
# "Use a log level over 10 to enable all debugging options."
3165
2533
# - GnuTLS manual
3166
gnutls.global_set_log_level(11)
3167
3168
@gnutls.log_func
2534
gnutls.library.functions.gnutls_global_set_log_level(11)
2535
2536
@gnutls.library.types.gnutls_log_func
3169
2537
def debug_gnutls(level, string):
3170
2538
logger.debug("GnuTLS: %s", string[:-1])
3171
3172
gnutls.global_set_log_function(debug_gnutls)
3173
2539
2540
gnutls.library.functions.gnutls_global_set_log_function(
2541
debug_gnutls)
2542
3174
2543
# Redirect stdin so all checkers get /dev/null
3175
2544
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3176
2545
os.dup2(null, sys.stdin.fileno())
3177
2546
if null > 2:
3178
2547
os.close(null)
3179
2548
3180
2549
# Need to fork before connecting to D-Bus
3181
2550
if not foreground:
3182
2551
# Close all input and output, do double fork, etc.
3183
2552
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
2553
2554
# multiprocessing will use threads, so before we use gobject we
2555
# need to inform gobject that threads will be used.
2556
gobject.threads_init()
2557
3190
2558
global main_loop
3191
2559
# From the Avahi example code
3192
2560
DBusGMainLoop(set_as_default=True)
3193
main_loop = GLib.MainLoop()
2561
main_loop = gobject.MainLoop()
3194
2562
bus = dbus.SystemBus()
3195
2563
# End of Avahi example code
3196
2564
if use_dbus:
3209
2577
if zeroconf:
3210
2578
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3211
2579
service = AvahiServiceToSyslog(
3212
name=server_settings["servicename"],
3213
servicetype="_mandos._tcp",
3214
protocol=protocol,
3215
bus=bus)
2580
name = server_settings["servicename"],
2581
servicetype = "_mandos._tcp",
2582
protocol = protocol,
2583
bus = bus)
3216
2584
if server_settings["interface"]:
3217
2585
service.interface = if_nametoindex(
3218
2586
server_settings["interface"].encode("utf-8"))
3219
2587
3220
2588
global multiprocessing_manager
3221
2589
multiprocessing_manager = multiprocessing.Manager()
3222
2590
3223
2591
client_class = Client
3224
2592
if use_dbus:
3225
client_class = functools.partial(ClientDBus, bus=bus)
3226
2593
client_class = functools.partial(ClientDBus, bus = bus)
2594
3227
2595
client_settings = Client.config_parser(client_config)
3228
2596
old_client_settings = {}
3229
2597
clients_data = {}
3230
2598
3231
2599
# This is used to redirect stdout and stderr for checker processes
3232
2600
global wnull
3233
wnull = open(os.devnull, "w") # A writable /dev/null
2601
wnull = open(os.devnull, "w") # A writable /dev/null
3234
2602
# Only used if server is running in foreground but not in debug
3235
2603
# mode
3236
2604
if debug or not foreground:
3237
2605
wnull.close()
3238
2606
3239
2607
# Get client data and settings from last running state.
3240
2608
if server_settings["restore"]:
3241
2609
try:
3242
2610
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"))
2611
clients_data, old_client_settings = pickle.load(
2612
stored_state)
3293
2613
os.remove(stored_state_path)
3294
2614
except IOError as e:
3295
2615
if e.errno == errno.ENOENT:
3303
2623
logger.warning("Could not load persistent state: "
3304
2624
"EOFError:",
3305
2625
exc_info=e)
3306
2626
3307
2627
with PGPEngine() as pgp:
3308
2628
for client_name, client in clients_data.items():
3309
2629
# Skip removed clients
3310
2630
if client_name not in client_settings:
3311
2631
continue
3312
2632
3313
2633
# Decide which value to use after restoring saved state.
3314
2634
# We have three different values: Old config file,
3315
2635
# new config file, and saved state.
3326
2646
client[name] = value
3327
2647
except KeyError:
3328
2648
pass
3329
2649
3330
2650
# Clients who has passed its expire date can still be
3331
2651
# enabled if its last checker was successful. A Client
3332
2652
# whose checker succeeded before we stored its state is
3365
2685
client_name))
3366
2686
client["secret"] = (client_settings[client_name]
3367
2687
["secret"])
3368
2688
3369
2689
# Add/remove clients based on new changes made to config
3370
2690
for client_name in (set(old_client_settings)
3371
2691
- set(client_settings)):
3373
2693
for client_name in (set(client_settings)
3374
2694
- set(old_client_settings)):
3375
2695
clients_data[client_name] = client_settings[client_name]
3376
2696
3377
2697
# Create all client objects
3378
2698
for client_name, client in clients_data.items():
3379
2699
tcp_server.clients[client_name] = client_class(
3380
name=client_name,
3381
settings=client,
3382
server_settings=server_settings)
3383
2700
name = client_name,
2701
settings = client,
2702
server_settings = server_settings)
2703
3384
2704
if not tcp_server.clients:
3385
2705
logger.warning("No clients defined")
3386
2706
3387
2707
if not foreground:
3388
2708
if pidfile is not None:
3389
2709
pid = os.getpid()
3395
2715
pidfilename, pid)
3396
2716
del pidfile
3397
2717
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
2718
2719
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2720
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2721
3403
2722
if use_dbus:
3404
2723
3405
2724
@alternate_dbus_interfaces(
3406
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3407
class MandosDBusService(DBusObjectWithObjectManager):
2725
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2726
class MandosDBusService(DBusObjectWithProperties):
3408
2727
"""A D-Bus proxy object"""
3409
2728
3410
2729
def __init__(self):
3411
2730
dbus.service.Object.__init__(self, bus, "/")
3412
2731
3413
2732
_interface = "se.recompile.Mandos"
3414
2733
2734
@dbus_interface_annotations(_interface)
2735
def _foo(self):
2736
return {
2737
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2738
"false" }
2739
3415
2740
@dbus.service.signal(_interface, signature="o")
3416
2741
def ClientAdded(self, objpath):
3417
2742
"D-Bus signal"
3418
2743
pass
3419
2744
3420
2745
@dbus.service.signal(_interface, signature="ss")
3421
def ClientNotFound(self, key_id, address):
2746
def ClientNotFound(self, fingerprint, address):
3422
2747
"D-Bus signal"
3423
2748
pass
3424
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3426
"true"})
2749
3427
2750
@dbus.service.signal(_interface, signature="os")
3428
2751
def ClientRemoved(self, objpath, name):
3429
2752
"D-Bus signal"
3430
2753
pass
3431
3432
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3433
"true"})
2754
3434
2755
@dbus.service.method(_interface, out_signature="ao")
3435
2756
def GetAllClients(self):
3436
2757
"D-Bus method"
3437
2758
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"})
2759
tcp_server.clients.itervalues())
2760
3442
2761
@dbus.service.method(_interface,
3443
2762
out_signature="a{oa{sv}}")
3444
2763
def GetAllClientsWithProperties(self):
3445
2764
"D-Bus method"
3446
2765
return dbus.Dictionary(
3447
{c.dbus_object_path: c.GetAll(
3448
"se.recompile.Mandos.Client")
3449
for c in tcp_server.clients.values()},
2766
{ c.dbus_object_path: c.GetAll("")
2767
for c in tcp_server.clients.itervalues() },
3450
2768
signature="oa{sv}")
3451
2769
3452
2770
@dbus.service.method(_interface, in_signature="o")
3453
2771
def RemoveClient(self, object_path):
3454
2772
"D-Bus method"
3455
for c in tcp_server.clients.values():
2773
for c in tcp_server.clients.itervalues():
3456
2774
if c.dbus_object_path == object_path:
3457
2775
del tcp_server.clients[c.name]
3458
2776
c.remove_from_connection()
3459
# Don't signal the disabling
2777
# Don't signal anything except ClientRemoved
3460
2778
c.disable(quiet=True)
3461
# Emit D-Bus signal for removal
3462
self.client_removed_signal(c)
2779
# Emit D-Bus signal
2780
self.ClientRemoved(object_path, c.name)
3463
2781
return
3464
2782
raise KeyError(object_path)
3465
2783
3466
2784
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
2785
3504
2786
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
2787
3511
2788
def cleanup():
3512
2789
"Cleanup function; run on exit"
3513
2790
if zeroconf:
3514
2791
service.cleanup()
3515
3516
mp.active_children()
3517
wn.close()
2792
2793
multiprocessing.active_children()
2794
wnull.close()
3518
2795
if not (tcp_server.clients or client_settings):
3519
2796
return
3520
2797
3521
2798
# Store client before exiting. Secrets are encrypted with key
3522
2799
# based on what config file has. If config file is
3523
2800
# removed/edited, old secret will thus be unrecovable.
3524
2801
clients = {}
3525
2802
with PGPEngine() as pgp:
3526
for client in tcp_server.clients.values():
2803
for client in tcp_server.clients.itervalues():
3527
2804
key = client_settings[client.name]["secret"]
3528
2805
client.encrypted_secret = pgp.encrypt(client.secret,
3529
2806
key)
3530
2807
client_dict = {}
3531
2808
3532
2809
# A list of attributes that can not be pickled
3533
2810
# + secret.
3534
exclude = {"bus", "changedstate", "secret",
3535
"checker", "server_settings"}
2811
exclude = { "bus", "changedstate", "secret",
2812
"checker", "server_settings" }
3536
2813
for name, typ in inspect.getmembers(dbus.service
3537
2814
.Object):
3538
2815
exclude.add(name)
3539
2816
3540
2817
client_dict["encrypted_secret"] = (client
3541
2818
.encrypted_secret)
3542
2819
for attr in client.client_structure:
3543
2820
if attr not in exclude:
3544
2821
client_dict[attr] = getattr(client, attr)
3545
2822
3546
2823
clients[client.name] = client_dict
3547
2824
del client_settings[client.name]["secret"]
3548
2825
3549
2826
try:
3550
2827
with tempfile.NamedTemporaryFile(
3551
2828
mode='wb',
3553
2830
prefix='clients-',
3554
2831
dir=os.path.dirname(stored_state_path),
3555
2832
delete=False) as stored_state:
3556
pickle.dump((clients, client_settings), stored_state,
3557
protocol=2)
2833
pickle.dump((clients, client_settings), stored_state)
3558
2834
tempname = stored_state.name
3559
2835
os.rename(tempname, stored_state_path)
3560
2836
except (IOError, OSError) as e:
3570
2846
logger.warning("Could not save persistent state:",
3571
2847
exc_info=e)
3572
2848
raise
3573
2849
3574
2850
# Delete all clients, and settings from config
3575
2851
while tcp_server.clients:
3576
2852
name, client = tcp_server.clients.popitem()
3577
2853
if use_dbus:
3578
2854
client.remove_from_connection()
3579
# Don't signal the disabling
2855
# Don't signal anything except ClientRemoved
3580
2856
client.disable(quiet=True)
3581
# Emit D-Bus signal for removal
3582
2857
if use_dbus:
3583
mandos_dbus_service.client_removed_signal(client)
2858
# Emit D-Bus signal
2859
mandos_dbus_service.ClientRemoved(
2860
client.dbus_object_path, client.name)
3584
2861
client_settings.clear()
3585
2862
3586
2863
atexit.register(cleanup)
3587
3588
for client in tcp_server.clients.values():
2864
2865
for client in tcp_server.clients.itervalues():
3589
2866
if use_dbus:
3590
# Emit D-Bus signal for adding
3591
mandos_dbus_service.client_added_signal(client)
2867
# Emit D-Bus signal
2868
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3592
2869
# Need to initiate checking of clients
3593
2870
if client.enabled:
3594
2871
client.init_checker()
3595
2872
3596
2873
tcp_server.enable()
3597
2874
tcp_server.server_activate()
3598
2875
3599
2876
# Find out what port we got
3600
2877
if zeroconf:
3601
2878
service.port = tcp_server.socket.getsockname()[1]
3606
2883
else: # IPv4
3607
2884
logger.info("Now listening on address %r, port %d",
3608
2885
*tcp_server.socket.getsockname())
3609
3610
# service.interface = tcp_server.socket.getsockname()[3]
3611
2886
2887
#service.interface = tcp_server.socket.getsockname()[3]
2888
3612
2889
try:
3613
2890
if zeroconf:
3614
2891
# From the Avahi example code
3619
2896
cleanup()
3620
2897
sys.exit(1)
3621
2898
# 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
2899
2900
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2901
lambda *args, **kwargs:
2902
(tcp_server.handle_request
2903
(*args[2:], **kwargs) or True))
2904
3629
2905
logger.debug("Starting main loop")
3630
2906
main_loop.run()
3631
2907
except AvahiError as error:
3640
2916
# Must run before the D-Bus bus name gets deregistered
3641
2917
cleanup()
3642
2918
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
2919
3660
2920
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()
2921
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0