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