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