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