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