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