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