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