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