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