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