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