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