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