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