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