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