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