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