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