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