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