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