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