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