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