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