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