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