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