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