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