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