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