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