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