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