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