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