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