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