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