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