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