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)
395
474
logger.error(bad_states[state] + ": %r", error)
396
475
self.cleanup()
397
476
elif state == avahi.SERVER_RUNNING:
398
self.add()
477
try:
478
self.add()
479
except dbus.exceptions.DBusException as error:
480
if (error.get_dbus_name()
481
== "org.freedesktop.Avahi.CollisionError"):
482
logger.info("Local Zeroconf service name"
483
" collision.")
484
return self.rename(remove=False)
485
else:
486
logger.critical("D-Bus Exception", exc_info=error)
487
self.cleanup()
488
os._exit(1)
399
489
else:
400
490
if error is None:
401
491
logger.debug("Unknown state: %r", state)
402
492
else:
403
493
logger.debug("Unknown state: %r: %r", state, error)
404
494
405
495
def activate(self):
406
496
"""Derived from the Avahi example code"""
407
497
if self.server is None:
418
508
class AvahiServiceToSyslog(AvahiService):
419
509
def rename(self, *args, **kwargs):
420
510
"""Add the new name to the syslog messages"""
421
ret = AvahiService.rename(self, *args, **kwargs)
511
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
422
512
syslogger.setFormatter(logging.Formatter(
423
513
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
424
514
.format(self.name)))
425
515
return ret
426
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
427
819
def call_pipe(connection, # : multiprocessing.Connection
428
820
func, *args, **kwargs):
429
821
"""This function is meant to be called by multiprocessing.Process
430
822
431
823
This function runs func(*args, **kwargs), and writes the resulting
432
824
return value on the provided multiprocessing.Connection.
433
825
"""
434
826
connection.send(func(*args, **kwargs))
435
827
connection.close()
436
828
437
class Client(object):
829
830
class Client:
438
831
"""A representation of a client host served by this server.
439
832
440
833
Attributes:
441
834
approved: bool(); 'None' if not yet approved/disapproved
442
835
approval_delay: datetime.timedelta(); Time to wait for approval
443
836
approval_duration: datetime.timedelta(); Duration of one approval
444
checker: subprocess.Popen(); a running checker process used
445
to see if the client lives.
446
'None' if no process is running.
447
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
448
841
checker_command: string; External command which is run to check
449
842
if client lives. %() expansions are done at
450
843
runtime with vars(self) as dict, so that for
451
844
instance %(name)s can be used in the command.
452
checker_initiator_tag: a gobject event source tag, or None
845
checker_initiator_tag: a GLib event source tag, or None
453
846
created: datetime.datetime(); (UTC) object creation
454
847
client_structure: Object describing what attributes a client has
455
848
and is used for storing the client at exit
456
849
current_checker_command: string; current running checker_command
457
disable_initiator_tag: a gobject event source tag, or None
850
disable_initiator_tag: a GLib event source tag, or None
458
851
enabled: bool()
459
852
fingerprint: string (40 or 32 hexadecimal digits); used to
460
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
461
856
host: string; available for use by the checker command
462
857
interval: datetime.timedelta(); How often to start a new checker
463
858
last_approval_request: datetime.datetime(); (UTC) or None
479
874
disabled, or None
480
875
server_settings: The server_settings dict from main()
481
876
"""
482
877
483
878
runtime_expansions = ("approval_delay", "approval_duration",
484
"created", "enabled", "expires",
879
"created", "enabled", "expires", "key_id",
485
880
"fingerprint", "host", "interval",
486
881
"last_approval_request", "last_checked_ok",
487
882
"last_enabled", "name", "timeout")
496
891
"approved_by_default": "True",
497
892
"enabled": "True",
498
893
}
499
894
500
895
@staticmethod
501
896
def config_parser(config):
502
897
"""Construct a new dict of client settings of this form:
509
904
for client_name in config.sections():
510
905
section = dict(config.items(client_name))
511
906
client = settings[client_name] = {}
512
907
513
908
client["host"] = section["host"]
514
909
# Reformat values from string types to Python types
515
910
client["approved_by_default"] = config.getboolean(
516
911
client_name, "approved_by_default")
517
912
client["enabled"] = config.getboolean(client_name,
518
913
"enabled")
519
520
# Uppercase and remove spaces from fingerprint for later
521
# comparison purposes with return value from the
522
# 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(" ", ""))
523
920
client["fingerprint"] = (section["fingerprint"].upper()
524
921
.replace(" ", ""))
525
922
if "secret" in section:
526
client["secret"] = section["secret"].decode("base64")
923
client["secret"] = codecs.decode(section["secret"]
924
.encode("utf-8"),
925
"base64")
527
926
elif "secfile" in section:
528
927
with open(os.path.expanduser(os.path.expandvars
529
928
(section["secfile"])),
544
943
client["last_approval_request"] = None
545
944
client["last_checked_ok"] = None
546
945
client["last_checker_status"] = -2
547
946
548
947
return settings
549
550
def __init__(self, settings, name = None, server_settings=None):
948
949
def __init__(self, settings, name=None, server_settings=None):
551
950
self.name = name
552
951
if server_settings is None:
553
952
server_settings = {}
555
954
# adding all client settings
556
955
for setting, value in settings.items():
557
956
setattr(self, setting, value)
558
957
559
958
if self.enabled:
560
959
if not hasattr(self, "last_enabled"):
561
960
self.last_enabled = datetime.datetime.utcnow()
565
964
else:
566
965
self.last_enabled = None
567
966
self.expires = None
568
967
569
968
logger.debug("Creating client %r", self.name)
969
logger.debug(" Key ID: %s", self.key_id)
570
970
logger.debug(" Fingerprint: %s", self.fingerprint)
571
971
self.created = settings.get("created",
572
972
datetime.datetime.utcnow())
573
973
574
974
# attributes specific for this server instance
575
975
self.checker = None
576
976
self.checker_initiator_tag = None
582
982
self.changedstate = multiprocessing_manager.Condition(
583
983
multiprocessing_manager.Lock())
584
984
self.client_structure = [attr
585
for attr in self.__dict__.iterkeys()
985
for attr in self.__dict__.keys()
586
986
if not attr.startswith("_")]
587
987
self.client_structure.append("client_structure")
588
988
589
989
for name, t in inspect.getmembers(
590
990
type(self), lambda obj: isinstance(obj, property)):
591
991
if not name.startswith("_"):
592
992
self.client_structure.append(name)
593
993
594
994
# Send notice to process children that client state has changed
595
995
def send_changedstate(self):
596
996
with self.changedstate:
597
997
self.changedstate.notify_all()
598
998
599
999
def enable(self):
600
1000
"""Start this client's checker and timeout hooks"""
601
1001
if getattr(self, "enabled", False):
606
1006
self.last_enabled = datetime.datetime.utcnow()
607
1007
self.init_checker()
608
1008
self.send_changedstate()
609
1009
610
1010
def disable(self, quiet=True):
611
1011
"""Disable this client."""
612
1012
if not getattr(self, "enabled", False):
614
1014
if not quiet:
615
1015
logger.info("Disabling client %s", self.name)
616
1016
if getattr(self, "disable_initiator_tag", None) is not None:
617
gobject.source_remove(self.disable_initiator_tag)
1017
GLib.source_remove(self.disable_initiator_tag)
618
1018
self.disable_initiator_tag = None
619
1019
self.expires = None
620
1020
if getattr(self, "checker_initiator_tag", None) is not None:
621
gobject.source_remove(self.checker_initiator_tag)
1021
GLib.source_remove(self.checker_initiator_tag)
622
1022
self.checker_initiator_tag = None
623
1023
self.stop_checker()
624
1024
self.enabled = False
625
1025
if not quiet:
626
1026
self.send_changedstate()
627
# 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
628
1028
return False
629
1029
630
1030
def __del__(self):
631
1031
self.disable()
632
1032
633
1033
def init_checker(self):
634
1034
# Schedule a new checker to be started an 'interval' from now,
635
1035
# and every interval from then on.
636
1036
if self.checker_initiator_tag is not None:
637
gobject.source_remove(self.checker_initiator_tag)
638
self.checker_initiator_tag = gobject.timeout_add(
639
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)),
640
1041
self.start_checker)
641
1042
# Schedule a disable() when 'timeout' has passed
642
1043
if self.disable_initiator_tag is not None:
643
gobject.source_remove(self.disable_initiator_tag)
644
self.disable_initiator_tag = gobject.timeout_add(
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
645
1046
int(self.timeout.total_seconds() * 1000), self.disable)
646
1047
# Also start a new checker *right now*.
647
1048
self.start_checker()
648
1049
649
1050
def checker_callback(self, source, condition, connection,
650
1051
command):
651
1052
"""The checker has completed, so take appropriate actions."""
652
self.checker_callback_tag = None
653
self.checker = None
654
1053
# Read return code from connection (see call_pipe)
655
1054
returncode = connection.recv()
656
1055
connection.close()
657
1056
if self.checker is not None:
1057
self.checker.join()
1058
self.checker_callback_tag = None
1059
self.checker = None
1060
658
1061
if returncode >= 0:
659
1062
self.last_checker_status = returncode
660
1063
self.last_checker_signal = None
670
1073
logger.warning("Checker for %(name)s crashed?",
671
1074
vars(self))
672
1075
return False
673
1076
674
1077
def checked_ok(self):
675
1078
"""Assert that the client has been seen, alive and well."""
676
1079
self.last_checked_ok = datetime.datetime.utcnow()
677
1080
self.last_checker_status = 0
678
1081
self.last_checker_signal = None
679
1082
self.bump_timeout()
680
1083
681
1084
def bump_timeout(self, timeout=None):
682
1085
"""Bump up the timeout for this client."""
683
1086
if timeout is None:
684
1087
timeout = self.timeout
685
1088
if self.disable_initiator_tag is not None:
686
gobject.source_remove(self.disable_initiator_tag)
1089
GLib.source_remove(self.disable_initiator_tag)
687
1090
self.disable_initiator_tag = None
688
1091
if getattr(self, "enabled", False):
689
self.disable_initiator_tag = gobject.timeout_add(
1092
self.disable_initiator_tag = GLib.timeout_add(
690
1093
int(timeout.total_seconds() * 1000), self.disable)
691
1094
self.expires = datetime.datetime.utcnow() + timeout
692
1095
693
1096
def need_approval(self):
694
1097
self.last_approval_request = datetime.datetime.utcnow()
695
1098
696
1099
def start_checker(self):
697
1100
"""Start a new checker subprocess if one is not running.
698
1101
699
1102
If a checker already exists, leave it running and do
700
1103
nothing."""
701
1104
# The reason for not killing a running checker is that if we
706
1109
# checkers alone, the checker would have to take more time
707
1110
# than 'timeout' for the client to be disabled, which is as it
708
1111
# should be.
709
1112
710
1113
if self.checker is not None and not self.checker.is_alive():
711
1114
logger.warning("Checker was not alive; joining")
712
1115
self.checker.join()
716
1119
# Escape attributes for the shell
717
1120
escaped_attrs = {
718
1121
attr: re.escape(str(getattr(self, attr)))
719
for attr in self.runtime_expansions }
1122
for attr in self.runtime_expansions}
720
1123
try:
721
1124
command = self.checker_command % escaped_attrs
722
1125
except TypeError as error:
734
1137
# The exception is when not debugging but nevertheless
735
1138
# running in the foreground; use the previously
736
1139
# created wnull.
737
popen_args = { "close_fds": True,
738
"shell": True,
739
"cwd": "/" }
1140
popen_args = {"close_fds": True,
1141
"shell": True,
1142
"cwd": "/"}
740
1143
if (not self.server_settings["debug"]
741
1144
and self.server_settings["foreground"]):
742
1145
popen_args.update({"stdout": wnull,
743
"stderr": wnull })
744
pipe = multiprocessing.Pipe(duplex = False)
1146
"stderr": wnull})
1147
pipe = multiprocessing.Pipe(duplex=False)
745
1148
self.checker = multiprocessing.Process(
746
target = call_pipe,
747
args = (pipe[1], subprocess.call, command),
748
kwargs = popen_args)
1149
target=call_pipe,
1150
args=(pipe[1], subprocess.call, command),
1151
kwargs=popen_args)
749
1152
self.checker.start()
750
self.checker_callback_tag = gobject.io_add_watch(
751
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,
752
1156
self.checker_callback, pipe[0], command)
753
# Re-run this periodically if run by gobject.timeout_add
1157
# Re-run this periodically if run by GLib.timeout_add
754
1158
return True
755
1159
756
1160
def stop_checker(self):
757
1161
"""Force the checker process, if any, to stop."""
758
1162
if self.checker_callback_tag:
759
gobject.source_remove(self.checker_callback_tag)
1163
GLib.source_remove(self.checker_callback_tag)
760
1164
self.checker_callback_tag = None
761
1165
if getattr(self, "checker", None) is None:
762
1166
return
771
1175
byte_arrays=False):
772
1176
"""Decorators for marking methods of a DBusObjectWithProperties to
773
1177
become properties on the D-Bus.
774
1178
775
1179
The decorated method will be called with no arguments by "Get"
776
1180
and with one argument by "Set".
777
1181
778
1182
The parameters, where they are supported, are the same as
779
1183
dbus.service.method, except there is only "signature", since the
780
1184
type from Get() and the type sent to Set() is the same.
784
1188
if byte_arrays and signature != "ay":
785
1189
raise ValueError("Byte arrays not supported for non-'ay'"
786
1190
" signature {!r}".format(signature))
787
1191
788
1192
def decorator(func):
789
1193
func._dbus_is_property = True
790
1194
func._dbus_interface = dbus_interface
793
1197
func._dbus_name = func.__name__
794
1198
if func._dbus_name.endswith("_dbus_property"):
795
1199
func._dbus_name = func._dbus_name[:-14]
796
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1200
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
797
1201
return func
798
1202
799
1203
return decorator
800
1204
801
1205
802
1206
def dbus_interface_annotations(dbus_interface):
803
1207
"""Decorator for marking functions returning interface annotations
804
1208
805
1209
Usage:
806
1210
807
1211
@dbus_interface_annotations("org.example.Interface")
808
1212
def _foo(self): # Function name does not matter
809
1213
return {"org.freedesktop.DBus.Deprecated": "true",
810
1214
"org.freedesktop.DBus.Property.EmitsChangedSignal":
811
1215
"false"}
812
1216
"""
813
1217
814
1218
def decorator(func):
815
1219
func._dbus_is_interface = True
816
1220
func._dbus_interface = dbus_interface
817
1221
func._dbus_name = dbus_interface
818
1222
return func
819
1223
820
1224
return decorator
821
1225
822
1226
823
1227
def dbus_annotations(annotations):
824
1228
"""Decorator to annotate D-Bus methods, signals or properties
825
1229
Usage:
826
1230
827
1231
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
828
1232
"org.freedesktop.DBus.Property."
829
1233
"EmitsChangedSignal": "false"})
831
1235
access="r")
832
1236
def Property_dbus_property(self):
833
1237
return dbus.Boolean(False)
1238
1239
See also the DBusObjectWithAnnotations class.
834
1240
"""
835
1241
836
1242
def decorator(func):
837
1243
func._dbus_annotations = annotations
838
1244
return func
839
1245
840
1246
return decorator
841
1247
842
1248
858
1264
pass
859
1265
860
1266
861
class DBusObjectWithProperties(dbus.service.Object):
862
"""A D-Bus object with properties.
863
864
Classes inheriting from this can use the dbus_service_property
865
decorator to expose methods as D-Bus properties. It exposes the
866
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.
867
1272
"""
868
1273
869
1274
@staticmethod
870
1275
def _is_dbus_thing(thing):
871
1276
"""Returns a function testing if an attribute is a D-Bus thing
872
1277
873
1278
If called like _is_dbus_thing("method") it returns a function
874
1279
suitable for use as predicate to inspect.getmembers().
875
1280
"""
876
1281
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
877
1282
False)
878
1283
879
1284
def _get_all_dbus_things(self, thing):
880
1285
"""Returns a generator of (name, attribute) pairs
881
1286
"""
884
1289
for cls in self.__class__.__mro__
885
1290
for name, athing in
886
1291
inspect.getmembers(cls, self._is_dbus_thing(thing)))
887
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
888
1364
def _get_dbus_property(self, interface_name, property_name):
889
1365
"""Returns a bound method if one exists which is a D-Bus
890
1366
property with the specified name and interface.
895
1371
if (value._dbus_name == property_name
896
1372
and value._dbus_interface == interface_name):
897
1373
return value.__get__(self)
898
1374
899
1375
# No such property
900
1376
raise DBusPropertyNotFound("{}:{}.{}".format(
901
1377
self.dbus_object_path, interface_name, property_name))
902
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
903
1388
@dbus.service.method(dbus.PROPERTIES_IFACE,
904
1389
in_signature="ss",
905
1390
out_signature="v")
913
1398
if not hasattr(value, "variant_level"):
914
1399
return value
915
1400
return type(value)(value, variant_level=value.variant_level+1)
916
1401
917
1402
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
918
1403
def Set(self, interface_name, property_name, value):
919
1404
"""Standard D-Bus property Set() method, see D-Bus standard.
928
1413
raise ValueError("Byte arrays not supported for non-"
929
1414
"'ay' signature {!r}"
930
1415
.format(prop._dbus_signature))
931
value = dbus.ByteArray(b''.join(chr(byte)
932
for byte in value))
1416
value = dbus.ByteArray(bytes(value))
933
1417
prop(value)
934
1418
935
1419
@dbus.service.method(dbus.PROPERTIES_IFACE,
936
1420
in_signature="s",
937
1421
out_signature="a{sv}")
938
1422
def GetAll(self, interface_name):
939
1423
"""Standard D-Bus property GetAll() method, see D-Bus
940
1424
standard.
941
1425
942
1426
Note: Will not include properties with access="write".
943
1427
"""
944
1428
properties = {}
955
1439
properties[name] = value
956
1440
continue
957
1441
properties[name] = type(value)(
958
value, variant_level = value.variant_level + 1)
1442
value, variant_level=value.variant_level + 1)
959
1443
return dbus.Dictionary(properties, signature="sv")
960
1444
961
1445
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
962
1446
def PropertiesChanged(self, interface_name, changed_properties,
963
1447
invalidated_properties):
965
1449
standard.
966
1450
"""
967
1451
pass
968
1452
969
1453
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
970
1454
out_signature="s",
971
1455
path_keyword='object_path',
972
1456
connection_keyword='connection')
973
1457
def Introspect(self, object_path, connection):
974
1458
"""Overloading of standard D-Bus method.
975
1459
976
1460
Inserts property tags and interface annotation tags.
977
1461
"""
978
xmlstring = dbus.service.Object.Introspect(self, object_path,
979
connection)
1462
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1463
object_path,
1464
connection)
980
1465
try:
981
1466
document = xml.dom.minidom.parseString(xmlstring)
982
1467
983
1468
def make_tag(document, name, prop):
984
1469
e = document.createElement("property")
985
1470
e.setAttribute("name", name)
986
1471
e.setAttribute("type", prop._dbus_signature)
987
1472
e.setAttribute("access", prop._dbus_access)
988
1473
return e
989
1474
990
1475
for if_tag in document.getElementsByTagName("interface"):
991
1476
# Add property tags
992
1477
for tag in (make_tag(document, name, prop)
995
1480
if prop._dbus_interface
996
1481
== if_tag.getAttribute("name")):
997
1482
if_tag.appendChild(tag)
998
# Add annotation tags
999
for typ in ("method", "signal", "property"):
1000
for tag in if_tag.getElementsByTagName(typ):
1001
annots = dict()
1002
for name, prop in (self.
1003
_get_all_dbus_things(typ)):
1004
if (name == tag.getAttribute("name")
1005
and prop._dbus_interface
1006
== if_tag.getAttribute("name")):
1007
annots.update(getattr(
1008
prop, "_dbus_annotations", {}))
1009
for name, value in annots.items():
1010
ann_tag = document.createElement(
1011
"annotation")
1012
ann_tag.setAttribute("name", name)
1013
ann_tag.setAttribute("value", value)
1014
tag.appendChild(ann_tag)
1015
# Add interface annotation tags
1016
for annotation, value in dict(
1017
itertools.chain.from_iterable(
1018
annotations().items()
1019
for name, annotations
1020
in self._get_all_dbus_things("interface")
1021
if name == if_tag.getAttribute("name")
1022
)).items():
1023
ann_tag = document.createElement("annotation")
1024
ann_tag.setAttribute("name", annotation)
1025
ann_tag.setAttribute("value", value)
1026
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)
1027
1499
# Add the names to the return values for the
1028
1500
# "org.freedesktop.DBus.Properties" methods
1029
1501
if (if_tag.getAttribute("name")
1048
1520
return xmlstring
1049
1521
1050
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
1051
1594
def datetime_to_dbus(dt, variant_level=0):
1052
1595
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1053
1596
if dt is None:
1054
return dbus.String("", variant_level = variant_level)
1597
return dbus.String("", variant_level=variant_level)
1055
1598
return dbus.String(dt.isoformat(), variant_level=variant_level)
1056
1599
1057
1600
1060
1603
dbus.service.Object, it will add alternate D-Bus attributes with
1061
1604
interface names according to the "alt_interface_names" mapping.
1062
1605
Usage:
1063
1606
1064
1607
@alternate_dbus_interfaces({"org.example.Interface":
1065
1608
"net.example.AlternateInterface"})
1066
1609
class SampleDBusObject(dbus.service.Object):
1067
1610
@dbus.service.method("org.example.Interface")
1068
1611
def SampleDBusMethod():
1069
1612
pass
1070
1613
1071
1614
The above "SampleDBusMethod" on "SampleDBusObject" will be
1072
1615
reachable via two interfaces: "org.example.Interface" and
1073
1616
"net.example.AlternateInterface", the latter of which will have
1074
1617
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1075
1618
"true", unless "deprecate" is passed with a False value.
1076
1619
1077
1620
This works for methods and signals, and also for D-Bus properties
1078
1621
(from DBusObjectWithProperties) and interfaces (from the
1079
1622
dbus_interface_annotations decorator).
1080
1623
"""
1081
1624
1082
1625
def wrapper(cls):
1083
1626
for orig_interface_name, alt_interface_name in (
1084
1627
alt_interface_names.items()):
1099
1642
interface_names.add(alt_interface)
1100
1643
# Is this a D-Bus signal?
1101
1644
if getattr(attribute, "_dbus_is_signal", False):
1645
# Extract the original non-method undecorated
1646
# function by black magic
1102
1647
if sys.version_info.major == 2:
1103
# Extract the original non-method undecorated
1104
# function by black magic
1105
1648
nonmethod_func = (dict(
1106
1649
zip(attribute.func_code.co_freevars,
1107
1650
attribute.__closure__))
1108
1651
["func"].cell_contents)
1109
1652
else:
1110
nonmethod_func = attribute
1653
nonmethod_func = (dict(
1654
zip(attribute.__code__.co_freevars,
1655
attribute.__closure__))
1656
["func"].cell_contents)
1111
1657
# Create a new, but exactly alike, function
1112
1658
# object, and decorate it to be a new D-Bus signal
1113
1659
# with the alternate D-Bus interface name
1114
if sys.version_info.major == 2:
1115
new_function = types.FunctionType(
1116
nonmethod_func.func_code,
1117
nonmethod_func.func_globals,
1118
nonmethod_func.func_name,
1119
nonmethod_func.func_defaults,
1120
nonmethod_func.func_closure)
1121
else:
1122
new_function = types.FunctionType(
1123
nonmethod_func.__code__,
1124
nonmethod_func.__globals__,
1125
nonmethod_func.__name__,
1126
nonmethod_func.__defaults__,
1127
nonmethod_func.__closure__)
1660
new_function = copy_function(nonmethod_func)
1128
1661
new_function = (dbus.service.signal(
1129
1662
alt_interface,
1130
1663
attribute._dbus_signature)(new_function))
1134
1667
attribute._dbus_annotations)
1135
1668
except AttributeError:
1136
1669
pass
1670
1137
1671
# Define a creator of a function to call both the
1138
1672
# original and alternate functions, so both the
1139
1673
# original and alternate signals gets sent when
1142
1676
"""This function is a scope container to pass
1143
1677
func1 and func2 to the "call_both" function
1144
1678
outside of its arguments"""
1145
1679
1680
@functools.wraps(func2)
1146
1681
def call_both(*args, **kwargs):
1147
1682
"""This function will emit two D-Bus
1148
1683
signals by calling func1 and func2"""
1149
1684
func1(*args, **kwargs)
1150
1685
func2(*args, **kwargs)
1151
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
1152
1692
return call_both
1153
1693
# Create the "call_both" function and add it to
1154
1694
# the class
1164
1704
alt_interface,
1165
1705
attribute._dbus_in_signature,
1166
1706
attribute._dbus_out_signature)
1167
(types.FunctionType(attribute.func_code,
1168
attribute.func_globals,
1169
attribute.func_name,
1170
attribute.func_defaults,
1171
attribute.func_closure)))
1707
(copy_function(attribute)))
1172
1708
# Copy annotations, if any
1173
1709
try:
1174
1710
attr[attrname]._dbus_annotations = dict(
1186
1722
attribute._dbus_access,
1187
1723
attribute._dbus_get_args_options
1188
1724
["byte_arrays"])
1189
(types.FunctionType(
1190
attribute.func_code,
1191
attribute.func_globals,
1192
attribute.func_name,
1193
attribute.func_defaults,
1194
attribute.func_closure)))
1725
(copy_function(attribute)))
1195
1726
# Copy annotations, if any
1196
1727
try:
1197
1728
attr[attrname]._dbus_annotations = dict(
1206
1737
# to the class.
1207
1738
attr[attrname] = (
1208
1739
dbus_interface_annotations(alt_interface)
1209
(types.FunctionType(attribute.func_code,
1210
attribute.func_globals,
1211
attribute.func_name,
1212
attribute.func_defaults,
1213
attribute.func_closure)))
1740
(copy_function(attribute)))
1214
1741
if deprecate:
1215
1742
# Deprecate all alternate interfaces
1216
iname="_AlternateDBusNames_interface_annotation{}"
1743
iname = "_AlternateDBusNames_interface_annotation{}"
1217
1744
for interface_name in interface_names:
1218
1745
1219
1746
@dbus_interface_annotations(interface_name)
1220
1747
def func(self):
1221
return { "org.freedesktop.DBus.Deprecated":
1222
"true" }
1748
return {"org.freedesktop.DBus.Deprecated":
1749
"true"}
1223
1750
# Find an unused name
1224
1751
for aname in (iname.format(i)
1225
1752
for i in itertools.count()):
1229
1756
if interface_names:
1230
1757
# Replace the class with a new subclass of it with
1231
1758
# methods, signals, etc. as created above.
1232
cls = type(b"{}Alternate".format(cls.__name__),
1233
(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)
1234
1765
return cls
1235
1766
1236
1767
return wrapper
1237
1768
1238
1769
1240
1771
"se.bsnet.fukt.Mandos"})
1241
1772
class ClientDBus(Client, DBusObjectWithProperties):
1242
1773
"""A Client class using D-Bus
1243
1774
1244
1775
Attributes:
1245
1776
dbus_object_path: dbus.ObjectPath
1246
1777
bus: dbus.SystemBus()
1247
1778
"""
1248
1779
1249
1780
runtime_expansions = (Client.runtime_expansions
1250
1781
+ ("dbus_object_path", ))
1251
1782
1252
1783
_interface = "se.recompile.Mandos.Client"
1253
1784
1254
1785
# dbus.service.Object doesn't use super(), so we can't either.
1255
1256
def __init__(self, bus = None, *args, **kwargs):
1786
1787
def __init__(self, bus=None, *args, **kwargs):
1257
1788
self.bus = bus
1258
1789
Client.__init__(self, *args, **kwargs)
1259
1790
# Only now, when this client is initialized, can it show up on
1265
1796
"/clients/" + client_object_name)
1266
1797
DBusObjectWithProperties.__init__(self, self.bus,
1267
1798
self.dbus_object_path)
1268
1799
1269
1800
def notifychangeproperty(transform_func, dbus_name,
1270
1801
type_func=lambda x: x,
1271
1802
variant_level=1,
1273
1804
_interface=_interface):
1274
1805
""" Modify a variable so that it's a property which announces
1275
1806
its changes to DBus.
1276
1807
1277
1808
transform_fun: Function that takes a value and a variant_level
1278
1809
and transforms it to a D-Bus type.
1279
1810
dbus_name: D-Bus name of the variable
1282
1813
variant_level: D-Bus variant level. Default: 1
1283
1814
"""
1284
1815
attrname = "_{}".format(dbus_name)
1285
1816
1286
1817
def setter(self, value):
1287
1818
if hasattr(self, "dbus_object_path"):
1288
1819
if (not hasattr(self, attrname) or
1295
1826
else:
1296
1827
dbus_value = transform_func(
1297
1828
type_func(value),
1298
variant_level = variant_level)
1829
variant_level=variant_level)
1299
1830
self.PropertyChanged(dbus.String(dbus_name),
1300
1831
dbus_value)
1301
1832
self.PropertiesChanged(
1302
1833
_interface,
1303
dbus.Dictionary({ dbus.String(dbus_name):
1304
dbus_value }),
1834
dbus.Dictionary({dbus.String(dbus_name):
1835
dbus_value}),
1305
1836
dbus.Array())
1306
1837
setattr(self, attrname, value)
1307
1838
1308
1839
return property(lambda self: getattr(self, attrname), setter)
1309
1840
1310
1841
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1311
1842
approvals_pending = notifychangeproperty(dbus.Boolean,
1312
1843
"ApprovalPending",
1313
type_func = bool)
1844
type_func=bool)
1314
1845
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1315
1846
last_enabled = notifychangeproperty(datetime_to_dbus,
1316
1847
"LastEnabled")
1317
1848
checker = notifychangeproperty(
1318
1849
dbus.Boolean, "CheckerRunning",
1319
type_func = lambda checker: checker is not None)
1850
type_func=lambda checker: checker is not None)
1320
1851
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1321
1852
"LastCheckedOK")
1322
1853
last_checker_status = notifychangeproperty(dbus.Int16,
1327
1858
"ApprovedByDefault")
1328
1859
approval_delay = notifychangeproperty(
1329
1860
dbus.UInt64, "ApprovalDelay",
1330
type_func = lambda td: td.total_seconds() * 1000)
1861
type_func=lambda td: td.total_seconds() * 1000)
1331
1862
approval_duration = notifychangeproperty(
1332
1863
dbus.UInt64, "ApprovalDuration",
1333
type_func = lambda td: td.total_seconds() * 1000)
1864
type_func=lambda td: td.total_seconds() * 1000)
1334
1865
host = notifychangeproperty(dbus.String, "Host")
1335
1866
timeout = notifychangeproperty(
1336
1867
dbus.UInt64, "Timeout",
1337
type_func = lambda td: td.total_seconds() * 1000)
1868
type_func=lambda td: td.total_seconds() * 1000)
1338
1869
extended_timeout = notifychangeproperty(
1339
1870
dbus.UInt64, "ExtendedTimeout",
1340
type_func = lambda td: td.total_seconds() * 1000)
1871
type_func=lambda td: td.total_seconds() * 1000)
1341
1872
interval = notifychangeproperty(
1342
1873
dbus.UInt64, "Interval",
1343
type_func = lambda td: td.total_seconds() * 1000)
1874
type_func=lambda td: td.total_seconds() * 1000)
1344
1875
checker_command = notifychangeproperty(dbus.String, "Checker")
1345
1876
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1346
1877
invalidate_only=True)
1347
1878
1348
1879
del notifychangeproperty
1349
1880
1350
1881
def __del__(self, *args, **kwargs):
1351
1882
try:
1352
1883
self.remove_from_connection()
1355
1886
if hasattr(DBusObjectWithProperties, "__del__"):
1356
1887
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1357
1888
Client.__del__(self, *args, **kwargs)
1358
1889
1359
1890
def checker_callback(self, source, condition,
1360
1891
connection, command, *args, **kwargs):
1361
1892
ret = Client.checker_callback(self, source, condition,
1365
1896
if exitstatus >= 0:
1366
1897
# Emit D-Bus signal
1367
1898
self.CheckerCompleted(dbus.Int16(exitstatus),
1368
dbus.Int64(0),
1899
# This is specific to GNU libC
1900
dbus.Int64(exitstatus << 8),
1369
1901
dbus.String(command))
1370
1902
else:
1371
1903
# Emit D-Bus signal
1372
1904
self.CheckerCompleted(dbus.Int16(-1),
1373
1905
dbus.Int64(
1374
self.last_checker_signal),
1906
# This is specific to GNU libC
1907
(exitstatus << 8)
1908
| self.last_checker_signal),
1375
1909
dbus.String(command))
1376
1910
return ret
1377
1911
1378
1912
def start_checker(self, *args, **kwargs):
1379
1913
old_checker_pid = getattr(self.checker, "pid", None)
1380
1914
r = Client.start_checker(self, *args, **kwargs)
1384
1918
# Emit D-Bus signal
1385
1919
self.CheckerStarted(self.current_checker_command)
1386
1920
return r
1387
1921
1388
1922
def _reset_approved(self):
1389
1923
self.approved = None
1390
1924
return False
1391
1925
1392
1926
def approve(self, value=True):
1393
1927
self.approved = value
1394
gobject.timeout_add(int(self.approval_duration.total_seconds()
1395
* 1000), self._reset_approved)
1928
GLib.timeout_add(int(self.approval_duration.total_seconds()
1929
* 1000), self._reset_approved)
1396
1930
self.send_changedstate()
1397
1398
## D-Bus methods, signals & properties
1399
1400
## Interfaces
1401
1402
## Signals
1403
1931
1932
# D-Bus methods, signals & properties
1933
1934
# Interfaces
1935
1936
# Signals
1937
1404
1938
# CheckerCompleted - signal
1405
1939
@dbus.service.signal(_interface, signature="nxs")
1406
1940
def CheckerCompleted(self, exitcode, waitstatus, command):
1407
1941
"D-Bus signal"
1408
1942
pass
1409
1943
1410
1944
# CheckerStarted - signal
1411
1945
@dbus.service.signal(_interface, signature="s")
1412
1946
def CheckerStarted(self, command):
1413
1947
"D-Bus signal"
1414
1948
pass
1415
1949
1416
1950
# PropertyChanged - signal
1417
1951
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1418
1952
@dbus.service.signal(_interface, signature="sv")
1419
1953
def PropertyChanged(self, property, value):
1420
1954
"D-Bus signal"
1421
1955
pass
1422
1956
1423
1957
# GotSecret - signal
1424
1958
@dbus.service.signal(_interface)
1425
1959
def GotSecret(self):
1428
1962
server to mandos-client
1429
1963
"""
1430
1964
pass
1431
1965
1432
1966
# Rejected - signal
1433
1967
@dbus.service.signal(_interface, signature="s")
1434
1968
def Rejected(self, reason):
1435
1969
"D-Bus signal"
1436
1970
pass
1437
1971
1438
1972
# NeedApproval - signal
1439
1973
@dbus.service.signal(_interface, signature="tb")
1440
1974
def NeedApproval(self, timeout, default):
1441
1975
"D-Bus signal"
1442
1976
return self.need_approval()
1443
1444
## Methods
1445
1977
1978
# Methods
1979
1446
1980
# Approve - method
1447
1981
@dbus.service.method(_interface, in_signature="b")
1448
1982
def Approve(self, value):
1449
1983
self.approve(value)
1450
1984
1451
1985
# CheckedOK - method
1452
1986
@dbus.service.method(_interface)
1453
1987
def CheckedOK(self):
1454
1988
self.checked_ok()
1455
1989
1456
1990
# Enable - method
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1457
1992
@dbus.service.method(_interface)
1458
1993
def Enable(self):
1459
1994
"D-Bus method"
1460
1995
self.enable()
1461
1996
1462
1997
# StartChecker - method
1998
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1463
1999
@dbus.service.method(_interface)
1464
2000
def StartChecker(self):
1465
2001
"D-Bus method"
1466
2002
self.start_checker()
1467
2003
1468
2004
# Disable - method
2005
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1469
2006
@dbus.service.method(_interface)
1470
2007
def Disable(self):
1471
2008
"D-Bus method"
1472
2009
self.disable()
1473
2010
1474
2011
# StopChecker - method
2012
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1475
2013
@dbus.service.method(_interface)
1476
2014
def StopChecker(self):
1477
2015
self.stop_checker()
1478
1479
## Properties
1480
2016
2017
# Properties
2018
1481
2019
# ApprovalPending - property
1482
2020
@dbus_service_property(_interface, signature="b", access="read")
1483
2021
def ApprovalPending_dbus_property(self):
1484
2022
return dbus.Boolean(bool(self.approvals_pending))
1485
2023
1486
2024
# ApprovedByDefault - property
1487
2025
@dbus_service_property(_interface,
1488
2026
signature="b",
1491
2029
if value is None: # get
1492
2030
return dbus.Boolean(self.approved_by_default)
1493
2031
self.approved_by_default = bool(value)
1494
2032
1495
2033
# ApprovalDelay - property
1496
2034
@dbus_service_property(_interface,
1497
2035
signature="t",
1501
2039
return dbus.UInt64(self.approval_delay.total_seconds()
1502
2040
* 1000)
1503
2041
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1504
2042
1505
2043
# ApprovalDuration - property
1506
2044
@dbus_service_property(_interface,
1507
2045
signature="t",
1511
2049
return dbus.UInt64(self.approval_duration.total_seconds()
1512
2050
* 1000)
1513
2051
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1514
2052
1515
2053
# Name - property
2054
@dbus_annotations(
2055
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1516
2056
@dbus_service_property(_interface, signature="s", access="read")
1517
2057
def Name_dbus_property(self):
1518
2058
return dbus.String(self.name)
1519
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
1520
2067
# Fingerprint - property
2068
@dbus_annotations(
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1521
2070
@dbus_service_property(_interface, signature="s", access="read")
1522
2071
def Fingerprint_dbus_property(self):
1523
2072
return dbus.String(self.fingerprint)
1524
2073
1525
2074
# Host - property
1526
2075
@dbus_service_property(_interface,
1527
2076
signature="s",
1530
2079
if value is None: # get
1531
2080
return dbus.String(self.host)
1532
2081
self.host = str(value)
1533
2082
1534
2083
# Created - property
2084
@dbus_annotations(
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1535
2086
@dbus_service_property(_interface, signature="s", access="read")
1536
2087
def Created_dbus_property(self):
1537
2088
return datetime_to_dbus(self.created)
1538
2089
1539
2090
# LastEnabled - property
1540
2091
@dbus_service_property(_interface, signature="s", access="read")
1541
2092
def LastEnabled_dbus_property(self):
1542
2093
return datetime_to_dbus(self.last_enabled)
1543
2094
1544
2095
# Enabled - property
1545
2096
@dbus_service_property(_interface,
1546
2097
signature="b",
1552
2103
self.enable()
1553
2104
else:
1554
2105
self.disable()
1555
2106
1556
2107
# LastCheckedOK - property
1557
2108
@dbus_service_property(_interface,
1558
2109
signature="s",
1562
2113
self.checked_ok()
1563
2114
return
1564
2115
return datetime_to_dbus(self.last_checked_ok)
1565
2116
1566
2117
# LastCheckerStatus - property
1567
2118
@dbus_service_property(_interface, signature="n", access="read")
1568
2119
def LastCheckerStatus_dbus_property(self):
1569
2120
return dbus.Int16(self.last_checker_status)
1570
2121
1571
2122
# Expires - property
1572
2123
@dbus_service_property(_interface, signature="s", access="read")
1573
2124
def Expires_dbus_property(self):
1574
2125
return datetime_to_dbus(self.expires)
1575
2126
1576
2127
# LastApprovalRequest - property
1577
2128
@dbus_service_property(_interface, signature="s", access="read")
1578
2129
def LastApprovalRequest_dbus_property(self):
1579
2130
return datetime_to_dbus(self.last_approval_request)
1580
2131
1581
2132
# Timeout - property
1582
2133
@dbus_service_property(_interface,
1583
2134
signature="t",
1598
2149
if (getattr(self, "disable_initiator_tag", None)
1599
2150
is None):
1600
2151
return
1601
gobject.source_remove(self.disable_initiator_tag)
1602
self.disable_initiator_tag = gobject.timeout_add(
2152
GLib.source_remove(self.disable_initiator_tag)
2153
self.disable_initiator_tag = GLib.timeout_add(
1603
2154
int((self.expires - now).total_seconds() * 1000),
1604
2155
self.disable)
1605
2156
1606
2157
# ExtendedTimeout - property
1607
2158
@dbus_service_property(_interface,
1608
2159
signature="t",
1612
2163
return dbus.UInt64(self.extended_timeout.total_seconds()
1613
2164
* 1000)
1614
2165
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1615
2166
1616
2167
# Interval - property
1617
2168
@dbus_service_property(_interface,
1618
2169
signature="t",
1625
2176
return
1626
2177
if self.enabled:
1627
2178
# Reschedule checker run
1628
gobject.source_remove(self.checker_initiator_tag)
1629
self.checker_initiator_tag = gobject.timeout_add(
2179
GLib.source_remove(self.checker_initiator_tag)
2180
self.checker_initiator_tag = GLib.timeout_add(
1630
2181
value, self.start_checker)
1631
self.start_checker() # Start one now, too
1632
2182
self.start_checker() # Start one now, too
2183
1633
2184
# Checker - property
1634
2185
@dbus_service_property(_interface,
1635
2186
signature="s",
1638
2189
if value is None: # get
1639
2190
return dbus.String(self.checker_command)
1640
2191
self.checker_command = str(value)
1641
2192
1642
2193
# CheckerRunning - property
1643
2194
@dbus_service_property(_interface,
1644
2195
signature="b",
1650
2201
self.start_checker()
1651
2202
else:
1652
2203
self.stop_checker()
1653
2204
1654
2205
# ObjectPath - property
2206
@dbus_annotations(
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2208
"org.freedesktop.DBus.Deprecated": "true"})
1655
2209
@dbus_service_property(_interface, signature="o", access="read")
1656
2210
def ObjectPath_dbus_property(self):
1657
return self.dbus_object_path # is already a dbus.ObjectPath
1658
2211
return self.dbus_object_path # is already a dbus.ObjectPath
2212
1659
2213
# Secret = property
2214
@dbus_annotations(
2215
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2216
"invalidates"})
1660
2217
@dbus_service_property(_interface,
1661
2218
signature="ay",
1662
2219
access="write",
1663
2220
byte_arrays=True)
1664
2221
def Secret_dbus_property(self, value):
1665
2222
self.secret = bytes(value)
1666
2223
1667
2224
del _interface
1668
2225
1669
2226
1670
class ProxyClient(object):
1671
def __init__(self, child_pipe, fpr, address):
2227
class ProxyClient:
2228
def __init__(self, child_pipe, key_id, fpr, address):
1672
2229
self._pipe = child_pipe
1673
self._pipe.send(('init', fpr, address))
2230
self._pipe.send(('init', key_id, fpr, address))
1674
2231
if not self._pipe.recv():
1675
raise KeyError(fpr)
1676
2232
raise KeyError(key_id or fpr)
2233
1677
2234
def __getattribute__(self, name):
1678
2235
if name == '_pipe':
1679
2236
return super(ProxyClient, self).__getattribute__(name)
1682
2239
if data[0] == 'data':
1683
2240
return data[1]
1684
2241
if data[0] == 'function':
1685
2242
1686
2243
def func(*args, **kwargs):
1687
2244
self._pipe.send(('funcall', name, args, kwargs))
1688
2245
return self._pipe.recv()[1]
1689
2246
1690
2247
return func
1691
2248
1692
2249
def __setattr__(self, name, value):
1693
2250
if name == '_pipe':
1694
2251
return super(ProxyClient, self).__setattr__(name, value)
1697
2254
1698
2255
class ClientHandler(socketserver.BaseRequestHandler, object):
1699
2256
"""A class to handle client connections.
1700
2257
1701
2258
Instantiated once for each connection to handle it.
1702
2259
Note: This will run in its own forked process."""
1703
2260
1704
2261
def handle(self):
1705
2262
with contextlib.closing(self.server.child_pipe) as child_pipe:
1706
2263
logger.info("TCP connection from: %s",
1707
2264
str(self.client_address))
1708
2265
logger.debug("Pipe FD: %d",
1709
2266
self.server.child_pipe.fileno())
1710
1711
session = gnutls.connection.ClientSession(
1712
self.request, gnutls.connection .X509Credentials())
1713
1714
# Note: gnutls.connection.X509Credentials is really a
1715
# generic GnuTLS certificate credentials object so long as
1716
# no X.509 keys are added to it. Therefore, we can use it
1717
# here despite using OpenPGP certificates.
1718
1719
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1720
# "+AES-256-CBC", "+SHA1",
1721
# "+COMP-NULL", "+CTYPE-OPENPGP",
1722
# "+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"))
1723
2274
# Use a fallback default, since this MUST be set.
1724
2275
priority = self.server.gnutls_priority
1725
2276
if priority is None:
1726
2277
priority = "NORMAL"
1727
gnutls.library.functions.gnutls_priority_set_direct(
1728
session._c_object, priority, None)
1729
2278
gnutls.priority_set_direct(session._c_object,
2279
priority.encode("utf-8"),
2280
None)
2281
1730
2282
# Start communication using the Mandos protocol
1731
2283
# Get protocol number
1732
2284
line = self.request.makefile().readline()
1737
2289
except (ValueError, IndexError, RuntimeError) as error:
1738
2290
logger.error("Unknown protocol version: %s", error)
1739
2291
return
1740
2292
1741
2293
# Start GnuTLS connection
1742
2294
try:
1743
2295
session.handshake()
1744
except gnutls.errors.GNUTLSError as error:
2296
except gnutls.Error as error:
1745
2297
logger.warning("Handshake failed: %s", error)
1746
2298
# Do not run session.bye() here: the session is not
1747
2299
# established. Just abandon the request.
1748
2300
return
1749
2301
logger.debug("Handshake succeeded")
1750
2302
1751
2303
approval_required = False
1752
2304
try:
1753
try:
1754
fpr = self.fingerprint(
1755
self.peer_certificate(session))
1756
except (TypeError,
1757
gnutls.errors.GNUTLSError) as error:
1758
logger.warning("Bad certificate: %s", error)
1759
return
1760
logger.debug("Fingerprint: %s", fpr)
1761
1762
try:
1763
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,
1764
2327
self.client_address)
1765
2328
except KeyError:
1766
2329
return
1767
2330
1768
2331
if client.approval_delay:
1769
2332
delay = client.approval_delay
1770
2333
client.approvals_pending += 1
1771
2334
approval_required = True
1772
2335
1773
2336
while True:
1774
2337
if not client.enabled:
1775
2338
logger.info("Client %s is disabled",
1778
2341
# Emit D-Bus signal
1779
2342
client.Rejected("Disabled")
1780
2343
return
1781
2344
1782
2345
if client.approved or not client.approval_delay:
1783
#We are approved or approval is disabled
2346
# We are approved or approval is disabled
1784
2347
break
1785
2348
elif client.approved is None:
1786
2349
logger.info("Client %s needs approval",
1797
2360
# Emit D-Bus signal
1798
2361
client.Rejected("Denied")
1799
2362
return
1800
1801
#wait until timeout or approved
2363
2364
# wait until timeout or approved
1802
2365
time = datetime.datetime.now()
1803
2366
client.changedstate.acquire()
1804
2367
client.changedstate.wait(delay.total_seconds())
1817
2380
break
1818
2381
else:
1819
2382
delay -= time2 - time
1820
1821
sent_size = 0
1822
while sent_size < len(client.secret):
1823
try:
1824
sent = session.send(client.secret[sent_size:])
1825
except gnutls.errors.GNUTLSError as error:
1826
logger.warning("gnutls send failed",
1827
exc_info=error)
1828
return
1829
logger.debug("Sent: %d, remaining: %d", sent,
1830
len(client.secret) - (sent_size
1831
+ sent))
1832
sent_size += sent
1833
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
1834
2391
logger.info("Sending secret to %s", client.name)
1835
2392
# bump the timeout using extended_timeout
1836
2393
client.bump_timeout(client.extended_timeout)
1837
2394
if self.server.use_dbus:
1838
2395
# Emit D-Bus signal
1839
2396
client.GotSecret()
1840
2397
1841
2398
finally:
1842
2399
if approval_required:
1843
2400
client.approvals_pending -= 1
1844
2401
try:
1845
2402
session.bye()
1846
except gnutls.errors.GNUTLSError as error:
2403
except gnutls.Error as error:
1847
2404
logger.warning("GnuTLS bye failed",
1848
2405
exc_info=error)
1849
2406
1850
2407
@staticmethod
1851
2408
def peer_certificate(session):
1852
"Return the peer's OpenPGP certificate as a bytestring"
1853
# If not an OpenPGP certificate...
1854
if (gnutls.library.functions.gnutls_certificate_type_get(
1855
session._c_object)
1856
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1857
# ...do the normal thing
1858
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""
1859
2425
list_size = ctypes.c_uint(1)
1860
cert_list = (gnutls.library.functions
1861
.gnutls_certificate_get_peers
2426
cert_list = (gnutls.certificate_get_peers
1862
2427
(session._c_object, ctypes.byref(list_size)))
1863
2428
if not bool(cert_list) and list_size.value != 0:
1864
raise gnutls.errors.GNUTLSError("error getting peer"
1865
" certificate")
2429
raise gnutls.Error("error getting peer certificate")
1866
2430
if list_size.value == 0:
1867
2431
return None
1868
2432
cert = cert_list[0]
1869
2433
return ctypes.string_at(cert.data, cert.size)
1870
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
1871
2469
@staticmethod
1872
2470
def fingerprint(openpgp):
1873
2471
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1874
2472
# New GnuTLS "datum" with the OpenPGP public key
1875
datum = gnutls.library.types.gnutls_datum_t(
2473
datum = gnutls.datum_t(
1876
2474
ctypes.cast(ctypes.c_char_p(openpgp),
1877
2475
ctypes.POINTER(ctypes.c_ubyte)),
1878
2476
ctypes.c_uint(len(openpgp)))
1879
2477
# New empty GnuTLS certificate
1880
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1881
gnutls.library.functions.gnutls_openpgp_crt_init(
1882
ctypes.byref(crt))
2478
crt = gnutls.openpgp_crt_t()
2479
gnutls.openpgp_crt_init(ctypes.byref(crt))
1883
2480
# Import the OpenPGP public key into the certificate
1884
gnutls.library.functions.gnutls_openpgp_crt_import(
1885
crt, ctypes.byref(datum),
1886
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
2481
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2482
gnutls.OPENPGP_FMT_RAW)
1887
2483
# Verify the self signature in the key
1888
2484
crtverify = ctypes.c_uint()
1889
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1890
crt, 0, ctypes.byref(crtverify))
2485
gnutls.openpgp_crt_verify_self(crt, 0,
2486
ctypes.byref(crtverify))
1891
2487
if crtverify.value != 0:
1892
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1893
raise gnutls.errors.CertificateSecurityError(
1894
"Verify failed")
2488
gnutls.openpgp_crt_deinit(crt)
2489
raise gnutls.CertificateSecurityError(code
2490
=crtverify.value)
1895
2491
# New buffer for the fingerprint
1896
2492
buf = ctypes.create_string_buffer(20)
1897
2493
buf_len = ctypes.c_size_t()
1898
2494
# Get the fingerprint from the certificate into the buffer
1899
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1900
crt, ctypes.byref(buf), ctypes.byref(buf_len))
2495
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2496
ctypes.byref(buf_len))
1901
2497
# Deinit the certificate
1902
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2498
gnutls.openpgp_crt_deinit(crt)
1903
2499
# Convert the buffer to a Python bytestring
1904
2500
fpr = ctypes.string_at(buf, buf_len.value)
1905
2501
# Convert the bytestring to hexadecimal notation
1907
2503
return hex_fpr
1908
2504
1909
2505
1910
class MultiprocessingMixIn(object):
2506
class MultiprocessingMixIn:
1911
2507
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1912
2508
1913
2509
def sub_process_main(self, request, address):
1914
2510
try:
1915
2511
self.finish_request(request, address)
1916
2512
except Exception:
1917
2513
self.handle_error(request, address)
1918
2514
self.close_request(request)
1919
2515
1920
2516
def process_request(self, request, address):
1921
2517
"""Start a new process to process the request."""
1922
proc = multiprocessing.Process(target = self.sub_process_main,
1923
args = (request, address))
2518
proc = multiprocessing.Process(target=self.sub_process_main,
2519
args=(request, address))
1924
2520
proc.start()
1925
2521
return proc
1926
2522
1927
2523
1928
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2524
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1929
2525
""" adds a pipe to the MixIn """
1930
2526
1931
2527
def process_request(self, request, client_address):
1932
2528
"""Overrides and wraps the original process_request().
1933
2529
1934
2530
This function creates a new pipe in self.pipe
1935
2531
"""
1936
2532
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1937
2533
1938
2534
proc = MultiprocessingMixIn.process_request(self, request,
1939
2535
client_address)
1940
2536
self.child_pipe.close()
1941
2537
self.add_pipe(parent_pipe, proc)
1942
2538
1943
2539
def add_pipe(self, parent_pipe, proc):
1944
2540
"""Dummy function; override as necessary"""
1945
2541
raise NotImplementedError()
1946
2542
1947
2543
1948
2544
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1949
socketserver.TCPServer, object):
2545
socketserver.TCPServer):
1950
2546
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1951
2547
1952
2548
Attributes:
1953
2549
enabled: Boolean; whether this server is activated yet
1954
2550
interface: None or a network interface name (string)
1955
2551
use_ipv6: Boolean; to use IPv6 or not
1956
2552
"""
1957
2553
1958
2554
def __init__(self, server_address, RequestHandlerClass,
1959
2555
interface=None,
1960
2556
use_ipv6=True,
1970
2566
self.socketfd = socketfd
1971
2567
# Save the original socket.socket() function
1972
2568
self.socket_socket = socket.socket
2569
1973
2570
# To implement --socket, we monkey patch socket.socket.
1974
#
2571
#
1975
2572
# (When socketserver.TCPServer is a new-style class, we
1976
2573
# could make self.socket into a property instead of monkey
1977
2574
# patching socket.socket.)
1978
#
2575
#
1979
2576
# Create a one-time-only replacement for socket.socket()
1980
2577
@functools.wraps(socket.socket)
1981
2578
def socket_wrapper(*args, **kwargs):
1993
2590
# socket_wrapper(), if socketfd was set.
1994
2591
socketserver.TCPServer.__init__(self, server_address,
1995
2592
RequestHandlerClass)
1996
2593
1997
2594
def server_bind(self):
1998
2595
"""This overrides the normal server_bind() function
1999
2596
to bind to an interface if one was specified, and also NOT to
2000
2597
bind to an address or port if they were not specified."""
2598
global SO_BINDTODEVICE
2001
2599
if self.interface is not None:
2002
2600
if SO_BINDTODEVICE is None:
2003
logger.error("SO_BINDTODEVICE does not exist;"
2004
" cannot bind to interface %s",
2005
self.interface)
2006
else:
2007
try:
2008
self.socket.setsockopt(
2009
socket.SOL_SOCKET, SO_BINDTODEVICE,
2010
(self.interface + "\0").encode("utf-8"))
2011
except socket.error as error:
2012
if error.errno == errno.EPERM:
2013
logger.error("No permission to bind to"
2014
" interface %s", self.interface)
2015
elif error.errno == errno.ENOPROTOOPT:
2016
logger.error("SO_BINDTODEVICE not available;"
2017
" cannot bind to interface %s",
2018
self.interface)
2019
elif error.errno == errno.ENODEV:
2020
logger.error("Interface %s does not exist,"
2021
" cannot bind", self.interface)
2022
else:
2023
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
2024
2622
# Only bind(2) the socket if we really need to.
2025
2623
if self.server_address[0] or self.server_address[1]:
2624
if self.server_address[1]:
2625
self.allow_reuse_address = True
2026
2626
if not self.server_address[0]:
2027
2627
if self.address_family == socket.AF_INET6:
2028
any_address = "::" # in6addr_any
2628
any_address = "::" # in6addr_any
2029
2629
else:
2030
any_address = "0.0.0.0" # INADDR_ANY
2630
any_address = "0.0.0.0" # INADDR_ANY
2031
2631
self.server_address = (any_address,
2032
2632
self.server_address[1])
2033
2633
elif not self.server_address[1]:
2043
2643
2044
2644
class MandosServer(IPv6_TCPServer):
2045
2645
"""Mandos server.
2046
2646
2047
2647
Attributes:
2048
2648
clients: set of Client objects
2049
2649
gnutls_priority GnuTLS priority string
2050
2650
use_dbus: Boolean; to emit D-Bus signals or not
2051
2052
Assumes a gobject.MainLoop event loop.
2651
2652
Assumes a GLib.MainLoop event loop.
2053
2653
"""
2054
2654
2055
2655
def __init__(self, server_address, RequestHandlerClass,
2056
2656
interface=None,
2057
2657
use_ipv6=True,
2067
2667
self.gnutls_priority = gnutls_priority
2068
2668
IPv6_TCPServer.__init__(self, server_address,
2069
2669
RequestHandlerClass,
2070
interface = interface,
2071
use_ipv6 = use_ipv6,
2072
socketfd = socketfd)
2073
2670
interface=interface,
2671
use_ipv6=use_ipv6,
2672
socketfd=socketfd)
2673
2074
2674
def server_activate(self):
2075
2675
if self.enabled:
2076
2676
return socketserver.TCPServer.server_activate(self)
2077
2677
2078
2678
def enable(self):
2079
2679
self.enabled = True
2080
2680
2081
2681
def add_pipe(self, parent_pipe, proc):
2082
2682
# Call "handle_ipc" for both data and EOF events
2083
gobject.io_add_watch(
2084
parent_pipe.fileno(),
2085
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,
2086
2686
functools.partial(self.handle_ipc,
2087
parent_pipe = parent_pipe,
2088
proc = proc))
2089
2687
parent_pipe=parent_pipe,
2688
proc=proc))
2689
2090
2690
def handle_ipc(self, source, condition,
2091
2691
parent_pipe=None,
2092
proc = None,
2692
proc=None,
2093
2693
client_object=None):
2094
2694
# error, or the other end of multiprocessing.Pipe has closed
2095
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2695
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2096
2696
# Wait for other process to exit
2097
2697
proc.join()
2098
2698
return False
2099
2699
2100
2700
# Read a request from the child
2101
2701
request = parent_pipe.recv()
2102
2702
command = request[0]
2103
2703
2104
2704
if command == 'init':
2105
fpr = request[1]
2106
address = request[2]
2107
2108
for c in self.clients.itervalues():
2109
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:
2110
2716
client = c
2111
2717
break
2112
2718
else:
2113
logger.info("Client not found for fingerprint: %s, ad"
2114
"dress: %s", fpr, address)
2719
logger.info("Client not found for key ID: %s, address"
2720
": %s", key_id or fpr, address)
2115
2721
if self.use_dbus:
2116
2722
# Emit D-Bus signal
2117
mandos_dbus_service.ClientNotFound(fpr,
2723
mandos_dbus_service.ClientNotFound(key_id or fpr,
2118
2724
address[0])
2119
2725
parent_pipe.send(False)
2120
2726
return False
2121
2122
gobject.io_add_watch(
2123
parent_pipe.fileno(),
2124
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,
2125
2731
functools.partial(self.handle_ipc,
2126
parent_pipe = parent_pipe,
2127
proc = proc,
2128
client_object = client))
2732
parent_pipe=parent_pipe,
2733
proc=proc,
2734
client_object=client))
2129
2735
parent_pipe.send(True)
2130
2736
# remove the old hook in favor of the new above hook on
2131
2737
# same fileno
2134
2740
funcname = request[1]
2135
2741
args = request[2]
2136
2742
kwargs = request[3]
2137
2743
2138
2744
parent_pipe.send(('data', getattr(client_object,
2139
2745
funcname)(*args,
2140
2746
**kwargs)))
2141
2747
2142
2748
if command == 'getattr':
2143
2749
attrname = request[1]
2144
2750
if isinstance(client_object.__getattribute__(attrname),
2147
2753
else:
2148
2754
parent_pipe.send((
2149
2755
'data', client_object.__getattribute__(attrname)))
2150
2756
2151
2757
if command == 'setattr':
2152
2758
attrname = request[1]
2153
2759
value = request[2]
2154
2760
setattr(client_object, attrname, value)
2155
2761
2156
2762
return True
2157
2763
2158
2764
2159
2765
def rfc3339_duration_to_delta(duration):
2160
2766
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2161
2162
>>> rfc3339_duration_to_delta("P7D")
2163
datetime.timedelta(7)
2164
>>> rfc3339_duration_to_delta("PT60S")
2165
datetime.timedelta(0, 60)
2166
>>> rfc3339_duration_to_delta("PT60M")
2167
datetime.timedelta(0, 3600)
2168
>>> rfc3339_duration_to_delta("PT24H")
2169
datetime.timedelta(1)
2170
>>> rfc3339_duration_to_delta("P1W")
2171
datetime.timedelta(7)
2172
>>> rfc3339_duration_to_delta("PT5M30S")
2173
datetime.timedelta(0, 330)
2174
>>> rfc3339_duration_to_delta("P1DT3M20S")
2175
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
2176
2782
"""
2177
2783
2178
2784
# Parsing an RFC 3339 duration with regular expressions is not
2179
2785
# possible - there would have to be multiple places for the same
2180
2786
# values, like seconds. The current code, while more esoteric, is
2181
2787
# cleaner without depending on a parsing library. If Python had a
2182
2788
# built-in library for parsing we would use it, but we'd like to
2183
2789
# avoid excessive use of external libraries.
2184
2790
2185
2791
# New type for defining tokens, syntax, and semantics all-in-one
2186
2792
Token = collections.namedtuple("Token", (
2187
2793
"regexp", # To match token; if "value" is not None, must have
2220
2826
frozenset((token_year, token_month,
2221
2827
token_day, token_time,
2222
2828
token_week)))
2223
# Define starting values
2224
value = datetime.timedelta() # Value so far
2829
# Define starting values:
2830
# Value so far
2831
value = datetime.timedelta()
2225
2832
found_token = None
2226
followers = frozenset((token_duration, )) # Following valid tokens
2227
s = duration # String left to parse
2833
# Following valid tokens
2834
followers = frozenset((token_duration, ))
2835
# String left to parse
2836
s = duration
2228
2837
# Loop until end token is found
2229
2838
while found_token is not token_end:
2230
2839
# Search for any currently valid tokens
2254
2863
2255
2864
def string_to_delta(interval):
2256
2865
"""Parse a string and return a datetime.timedelta
2257
2258
>>> string_to_delta('7d')
2259
datetime.timedelta(7)
2260
>>> string_to_delta('60s')
2261
datetime.timedelta(0, 60)
2262
>>> string_to_delta('60m')
2263
datetime.timedelta(0, 3600)
2264
>>> string_to_delta('24h')
2265
datetime.timedelta(1)
2266
>>> string_to_delta('1w')
2267
datetime.timedelta(7)
2268
>>> string_to_delta('5m 30s')
2269
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
2270
2879
"""
2271
2880
2272
2881
try:
2273
2882
return rfc3339_duration_to_delta(interval)
2274
2883
except ValueError:
2275
2884
pass
2276
2885
2277
2886
timevalue = datetime.timedelta(0)
2278
2887
for s in interval.split():
2279
2888
try:
2297
2906
return timevalue
2298
2907
2299
2908
2300
def daemon(nochdir = False, noclose = False):
2909
def daemon(nochdir=False, noclose=False):
2301
2910
"""See daemon(3). Standard BSD Unix function.
2302
2911
2303
2912
This should really exist as os.daemon, but it doesn't (yet)."""
2304
2913
if os.fork():
2305
2914
sys.exit()
2323
2932
2324
2933
2325
2934
def main():
2326
2935
2327
2936
##################################################################
2328
2937
# Parsing of options, both command line and config file
2329
2938
2330
2939
parser = argparse.ArgumentParser()
2331
2940
parser.add_argument("-v", "--version", action="version",
2332
version = "%(prog)s {}".format(version),
2941
version="%(prog)s {}".format(version),
2333
2942
help="show version number and exit")
2334
2943
parser.add_argument("-i", "--interface", metavar="IF",
2335
2944
help="Bind to interface IF")
2371
2980
parser.add_argument("--no-zeroconf", action="store_false",
2372
2981
dest="zeroconf", help="Do not use Zeroconf",
2373
2982
default=None)
2374
2983
2375
2984
options = parser.parse_args()
2376
2377
if options.check:
2378
import doctest
2379
fail_count, test_count = doctest.testmod()
2380
sys.exit(os.EX_OK if fail_count == 0 else 1)
2381
2985
2382
2986
# Default values for config file for server-global settings
2383
server_defaults = { "interface": "",
2384
"address": "",
2385
"port": "",
2386
"debug": "False",
2387
"priority":
2388
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2389
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2390
"servicename": "Mandos",
2391
"use_dbus": "True",
2392
"use_ipv6": "True",
2393
"debuglevel": "",
2394
"restore": "True",
2395
"socket": "",
2396
"statedir": "/var/lib/mandos",
2397
"foreground": "False",
2398
"zeroconf": "True",
2399
}
2400
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
2401
3010
# Parse config file for server-global settings
2402
server_config = configparser.SafeConfigParser(server_defaults)
3011
server_config = configparser.ConfigParser(server_defaults)
2403
3012
del server_defaults
2404
3013
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2405
# Convert the SafeConfigParser object to a dict
3014
# Convert the ConfigParser object to a dict
2406
3015
server_settings = server_config.defaults()
2407
3016
# Use the appropriate methods on the non-string config options
2408
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3017
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3018
"foreground", "zeroconf"):
2409
3019
server_settings[option] = server_config.getboolean("DEFAULT",
2410
3020
option)
2411
3021
if server_settings["port"]:
2421
3031
server_settings["socket"] = os.dup(server_settings
2422
3032
["socket"])
2423
3033
del server_config
2424
3034
2425
3035
# Override the settings from the config file with command line
2426
3036
# options, if set.
2427
3037
for option in ("interface", "address", "port", "debug",
2445
3055
if server_settings["debug"]:
2446
3056
server_settings["foreground"] = True
2447
3057
# Now we have our good server settings in "server_settings"
2448
3058
2449
3059
##################################################################
2450
3060
2451
3061
if (not server_settings["zeroconf"]
2452
3062
and not (server_settings["port"]
2453
3063
or server_settings["socket"] != "")):
2454
3064
parser.error("Needs port or socket to work without Zeroconf")
2455
3065
2456
3066
# For convenience
2457
3067
debug = server_settings["debug"]
2458
3068
debuglevel = server_settings["debuglevel"]
2462
3072
stored_state_file)
2463
3073
foreground = server_settings["foreground"]
2464
3074
zeroconf = server_settings["zeroconf"]
2465
3075
2466
3076
if debug:
2467
3077
initlogger(debug, logging.DEBUG)
2468
3078
else:
2471
3081
else:
2472
3082
level = getattr(logging, debuglevel.upper())
2473
3083
initlogger(debug, level)
2474
3084
2475
3085
if server_settings["servicename"] != "Mandos":
2476
3086
syslogger.setFormatter(
2477
3087
logging.Formatter('Mandos ({}) [%(process)d]:'
2478
3088
' %(levelname)s: %(message)s'.format(
2479
3089
server_settings["servicename"])))
2480
3090
2481
3091
# Parse config file with clients
2482
client_config = configparser.SafeConfigParser(Client
2483
.client_defaults)
3092
client_config = configparser.ConfigParser(Client.client_defaults)
2484
3093
client_config.read(os.path.join(server_settings["configdir"],
2485
3094
"clients.conf"))
2486
3095
2487
3096
global mandos_dbus_service
2488
3097
mandos_dbus_service = None
2489
3098
2490
3099
socketfd = None
2491
3100
if server_settings["socket"] != "":
2492
3101
socketfd = server_settings["socket"]
2508
3117
except IOError as e:
2509
3118
logger.error("Could not open file %r", pidfilename,
2510
3119
exc_info=e)
2511
2512
for name in ("_mandos", "mandos", "nobody"):
3120
3121
for name, group in (("_mandos", "_mandos"),
3122
("mandos", "mandos"),
3123
("nobody", "nogroup")):
2513
3124
try:
2514
3125
uid = pwd.getpwnam(name).pw_uid
2515
gid = pwd.getpwnam(name).pw_gid
3126
gid = pwd.getpwnam(group).pw_gid
2516
3127
break
2517
3128
except KeyError:
2518
3129
continue
2522
3133
try:
2523
3134
os.setgid(gid)
2524
3135
os.setuid(uid)
3136
if debug:
3137
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3138
gid))
2525
3139
except OSError as error:
3140
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3141
.format(uid, gid, os.strerror(error.errno)))
2526
3142
if error.errno != errno.EPERM:
2527
3143
raise
2528
3144
2529
3145
if debug:
2530
3146
# Enable all possible GnuTLS debugging
2531
3147
2532
3148
# "Use a log level over 10 to enable all debugging options."
2533
3149
# - GnuTLS manual
2534
gnutls.library.functions.gnutls_global_set_log_level(11)
2535
2536
@gnutls.library.types.gnutls_log_func
3150
gnutls.global_set_log_level(11)
3151
3152
@gnutls.log_func
2537
3153
def debug_gnutls(level, string):
2538
3154
logger.debug("GnuTLS: %s", string[:-1])
2539
2540
gnutls.library.functions.gnutls_global_set_log_function(
2541
debug_gnutls)
2542
3155
3156
gnutls.global_set_log_function(debug_gnutls)
3157
2543
3158
# Redirect stdin so all checkers get /dev/null
2544
3159
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2545
3160
os.dup2(null, sys.stdin.fileno())
2546
3161
if null > 2:
2547
3162
os.close(null)
2548
3163
2549
3164
# Need to fork before connecting to D-Bus
2550
3165
if not foreground:
2551
3166
# Close all input and output, do double fork, etc.
2552
3167
daemon()
2553
2554
# multiprocessing will use threads, so before we use gobject we
2555
# need to inform gobject that threads will be used.
2556
gobject.threads_init()
2557
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
2558
3174
global main_loop
2559
3175
# From the Avahi example code
2560
3176
DBusGMainLoop(set_as_default=True)
2561
main_loop = gobject.MainLoop()
3177
main_loop = GLib.MainLoop()
2562
3178
bus = dbus.SystemBus()
2563
3179
# End of Avahi example code
2564
3180
if use_dbus:
2577
3193
if zeroconf:
2578
3194
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2579
3195
service = AvahiServiceToSyslog(
2580
name = server_settings["servicename"],
2581
servicetype = "_mandos._tcp",
2582
protocol = protocol,
2583
bus = bus)
3196
name=server_settings["servicename"],
3197
servicetype="_mandos._tcp",
3198
protocol=protocol,
3199
bus=bus)
2584
3200
if server_settings["interface"]:
2585
3201
service.interface = if_nametoindex(
2586
3202
server_settings["interface"].encode("utf-8"))
2587
3203
2588
3204
global multiprocessing_manager
2589
3205
multiprocessing_manager = multiprocessing.Manager()
2590
3206
2591
3207
client_class = Client
2592
3208
if use_dbus:
2593
client_class = functools.partial(ClientDBus, bus = bus)
2594
3209
client_class = functools.partial(ClientDBus, bus=bus)
3210
2595
3211
client_settings = Client.config_parser(client_config)
2596
3212
old_client_settings = {}
2597
3213
clients_data = {}
2598
3214
2599
3215
# This is used to redirect stdout and stderr for checker processes
2600
3216
global wnull
2601
wnull = open(os.devnull, "w") # A writable /dev/null
3217
wnull = open(os.devnull, "w") # A writable /dev/null
2602
3218
# Only used if server is running in foreground but not in debug
2603
3219
# mode
2604
3220
if debug or not foreground:
2605
3221
wnull.close()
2606
3222
2607
3223
# Get client data and settings from last running state.
2608
3224
if server_settings["restore"]:
2609
3225
try:
2610
3226
with open(stored_state_path, "rb") as stored_state:
2611
clients_data, old_client_settings = pickle.load(
2612
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"))
2613
3277
os.remove(stored_state_path)
2614
3278
except IOError as e:
2615
3279
if e.errno == errno.ENOENT:
2623
3287
logger.warning("Could not load persistent state: "
2624
3288
"EOFError:",
2625
3289
exc_info=e)
2626
3290
2627
3291
with PGPEngine() as pgp:
2628
3292
for client_name, client in clients_data.items():
2629
3293
# Skip removed clients
2630
3294
if client_name not in client_settings:
2631
3295
continue
2632
3296
2633
3297
# Decide which value to use after restoring saved state.
2634
3298
# We have three different values: Old config file,
2635
3299
# new config file, and saved state.
2646
3310
client[name] = value
2647
3311
except KeyError:
2648
3312
pass
2649
3313
2650
3314
# Clients who has passed its expire date can still be
2651
3315
# enabled if its last checker was successful. A Client
2652
3316
# whose checker succeeded before we stored its state is
2685
3349
client_name))
2686
3350
client["secret"] = (client_settings[client_name]
2687
3351
["secret"])
2688
3352
2689
3353
# Add/remove clients based on new changes made to config
2690
3354
for client_name in (set(old_client_settings)
2691
3355
- set(client_settings)):
2693
3357
for client_name in (set(client_settings)
2694
3358
- set(old_client_settings)):
2695
3359
clients_data[client_name] = client_settings[client_name]
2696
3360
2697
3361
# Create all client objects
2698
3362
for client_name, client in clients_data.items():
2699
3363
tcp_server.clients[client_name] = client_class(
2700
name = client_name,
2701
settings = client,
2702
server_settings = server_settings)
2703
3364
name=client_name,
3365
settings=client,
3366
server_settings=server_settings)
3367
2704
3368
if not tcp_server.clients:
2705
3369
logger.warning("No clients defined")
2706
3370
2707
3371
if not foreground:
2708
3372
if pidfile is not None:
2709
3373
pid = os.getpid()
2715
3379
pidfilename, pid)
2716
3380
del pidfile
2717
3381
del pidfilename
2718
2719
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2720
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2721
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
2722
3387
if use_dbus:
2723
3388
2724
3389
@alternate_dbus_interfaces(
2725
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2726
class MandosDBusService(DBusObjectWithProperties):
3390
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3391
class MandosDBusService(DBusObjectWithObjectManager):
2727
3392
"""A D-Bus proxy object"""
2728
3393
2729
3394
def __init__(self):
2730
3395
dbus.service.Object.__init__(self, bus, "/")
2731
3396
2732
3397
_interface = "se.recompile.Mandos"
2733
2734
@dbus_interface_annotations(_interface)
2735
def _foo(self):
2736
return {
2737
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2738
"false" }
2739
3398
2740
3399
@dbus.service.signal(_interface, signature="o")
2741
3400
def ClientAdded(self, objpath):
2742
3401
"D-Bus signal"
2743
3402
pass
2744
3403
2745
3404
@dbus.service.signal(_interface, signature="ss")
2746
def ClientNotFound(self, fingerprint, address):
3405
def ClientNotFound(self, key_id, address):
2747
3406
"D-Bus signal"
2748
3407
pass
2749
3408
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3410
"true"})
2750
3411
@dbus.service.signal(_interface, signature="os")
2751
3412
def ClientRemoved(self, objpath, name):
2752
3413
"D-Bus signal"
2753
3414
pass
2754
3415
3416
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3417
"true"})
2755
3418
@dbus.service.method(_interface, out_signature="ao")
2756
3419
def GetAllClients(self):
2757
3420
"D-Bus method"
2758
3421
return dbus.Array(c.dbus_object_path for c in
2759
tcp_server.clients.itervalues())
2760
3422
tcp_server.clients.values())
3423
3424
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3425
"true"})
2761
3426
@dbus.service.method(_interface,
2762
3427
out_signature="a{oa{sv}}")
2763
3428
def GetAllClientsWithProperties(self):
2764
3429
"D-Bus method"
2765
3430
return dbus.Dictionary(
2766
{ c.dbus_object_path: c.GetAll("")
2767
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()},
2768
3434
signature="oa{sv}")
2769
3435
2770
3436
@dbus.service.method(_interface, in_signature="o")
2771
3437
def RemoveClient(self, object_path):
2772
3438
"D-Bus method"
2773
for c in tcp_server.clients.itervalues():
3439
for c in tcp_server.clients.values():
2774
3440
if c.dbus_object_path == object_path:
2775
3441
del tcp_server.clients[c.name]
2776
3442
c.remove_from_connection()
2777
# Don't signal anything except ClientRemoved
3443
# Don't signal the disabling
2778
3444
c.disable(quiet=True)
2779
# Emit D-Bus signal
2780
self.ClientRemoved(object_path, c.name)
3445
# Emit D-Bus signal for removal
3446
self.client_removed_signal(c)
2781
3447
return
2782
3448
raise KeyError(object_path)
2783
3449
2784
3450
del _interface
2785
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
2786
3488
mandos_dbus_service = MandosDBusService()
2787
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
2788
3495
def cleanup():
2789
3496
"Cleanup function; run on exit"
2790
3497
if zeroconf:
2791
3498
service.cleanup()
2792
2793
multiprocessing.active_children()
2794
wnull.close()
3499
3500
mp.active_children()
3501
wn.close()
2795
3502
if not (tcp_server.clients or client_settings):
2796
3503
return
2797
3504
2798
3505
# Store client before exiting. Secrets are encrypted with key
2799
3506
# based on what config file has. If config file is
2800
3507
# removed/edited, old secret will thus be unrecovable.
2801
3508
clients = {}
2802
3509
with PGPEngine() as pgp:
2803
for client in tcp_server.clients.itervalues():
3510
for client in tcp_server.clients.values():
2804
3511
key = client_settings[client.name]["secret"]
2805
3512
client.encrypted_secret = pgp.encrypt(client.secret,
2806
3513
key)
2807
3514
client_dict = {}
2808
3515
2809
3516
# A list of attributes that can not be pickled
2810
3517
# + secret.
2811
exclude = { "bus", "changedstate", "secret",
2812
"checker", "server_settings" }
3518
exclude = {"bus", "changedstate", "secret",
3519
"checker", "server_settings"}
2813
3520
for name, typ in inspect.getmembers(dbus.service
2814
3521
.Object):
2815
3522
exclude.add(name)
2816
3523
2817
3524
client_dict["encrypted_secret"] = (client
2818
3525
.encrypted_secret)
2819
3526
for attr in client.client_structure:
2820
3527
if attr not in exclude:
2821
3528
client_dict[attr] = getattr(client, attr)
2822
3529
2823
3530
clients[client.name] = client_dict
2824
3531
del client_settings[client.name]["secret"]
2825
3532
2826
3533
try:
2827
3534
with tempfile.NamedTemporaryFile(
2828
3535
mode='wb',
2830
3537
prefix='clients-',
2831
3538
dir=os.path.dirname(stored_state_path),
2832
3539
delete=False) as stored_state:
2833
pickle.dump((clients, client_settings), stored_state)
3540
pickle.dump((clients, client_settings), stored_state,
3541
protocol=2)
2834
3542
tempname = stored_state.name
2835
3543
os.rename(tempname, stored_state_path)
2836
3544
except (IOError, OSError) as e:
2846
3554
logger.warning("Could not save persistent state:",
2847
3555
exc_info=e)
2848
3556
raise
2849
3557
2850
3558
# Delete all clients, and settings from config
2851
3559
while tcp_server.clients:
2852
3560
name, client = tcp_server.clients.popitem()
2853
3561
if use_dbus:
2854
3562
client.remove_from_connection()
2855
# Don't signal anything except ClientRemoved
3563
# Don't signal the disabling
2856
3564
client.disable(quiet=True)
3565
# Emit D-Bus signal for removal
2857
3566
if use_dbus:
2858
# Emit D-Bus signal
2859
mandos_dbus_service.ClientRemoved(
2860
client.dbus_object_path, client.name)
3567
mandos_dbus_service.client_removed_signal(client)
2861
3568
client_settings.clear()
2862
3569
2863
3570
atexit.register(cleanup)
2864
2865
for client in tcp_server.clients.itervalues():
3571
3572
for client in tcp_server.clients.values():
2866
3573
if use_dbus:
2867
# Emit D-Bus signal
2868
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3574
# Emit D-Bus signal for adding
3575
mandos_dbus_service.client_added_signal(client)
2869
3576
# Need to initiate checking of clients
2870
3577
if client.enabled:
2871
3578
client.init_checker()
2872
3579
2873
3580
tcp_server.enable()
2874
3581
tcp_server.server_activate()
2875
3582
2876
3583
# Find out what port we got
2877
3584
if zeroconf:
2878
3585
service.port = tcp_server.socket.getsockname()[1]
2883
3590
else: # IPv4
2884
3591
logger.info("Now listening on address %r, port %d",
2885
3592
*tcp_server.socket.getsockname())
2886
2887
#service.interface = tcp_server.socket.getsockname()[3]
2888
3593
3594
# service.interface = tcp_server.socket.getsockname()[3]
3595
2889
3596
try:
2890
3597
if zeroconf:
2891
3598
# From the Avahi example code
2896
3603
cleanup()
2897
3604
sys.exit(1)
2898
3605
# End of Avahi example code
2899
2900
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2901
lambda *args, **kwargs:
2902
(tcp_server.handle_request
2903
(*args[2:], **kwargs) or True))
2904
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
2905
3613
logger.debug("Starting main loop")
2906
3614
main_loop.run()
2907
3615
except AvahiError as error:
2916
3624
# Must run before the D-Bus bus name gets deregistered
2917
3625
cleanup()
2918
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
2919
3643
2920
3644
if __name__ == '__main__':
2921
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