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