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