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