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