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