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