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