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