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