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