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