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