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