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