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