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
GLib.IOChannel.unix_new(pipe[0].fileno()),
1154
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1155
self.checker_callback, pipe[0], command)
1156
# 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
1157
684
return True
1158
685
1159
686
def stop_checker(self):
1160
687
"""Force the checker process, if any, to stop."""
1161
688
if self.checker_callback_tag:
1162
GLib.source_remove(self.checker_callback_tag)
689
gobject.source_remove(self.checker_callback_tag)
1163
690
self.checker_callback_tag = None
1164
691
if getattr(self, "checker", None) is None:
1165
692
return
1166
693
logger.debug("Stopping checker for %(name)s", vars(self))
1167
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
1168
702
self.checker = None
1169
703
1170
704
1171
def dbus_service_property(dbus_interface,
1172
signature="v",
1173
access="readwrite",
1174
byte_arrays=False):
705
def dbus_service_property(dbus_interface, signature="v",
706
access="readwrite", byte_arrays=False):
1175
707
"""Decorators for marking methods of a DBusObjectWithProperties to
1176
708
become properties on the D-Bus.
1177
709
1178
710
The decorated method will be called with no arguments by "Get"
1179
711
and with one argument by "Set".
1180
712
1181
713
The parameters, where they are supported, are the same as
1182
714
dbus.service.method, except there is only "signature", since the
1183
715
type from Get() and the type sent to Set() is the same.
1186
718
# "Set" method, so we fail early here:
1187
719
if byte_arrays and signature != "ay":
1188
720
raise ValueError("Byte arrays not supported for non-'ay'"
1189
" signature {!r}".format(signature))
1190
721
" signature %r" % signature)
1191
722
def decorator(func):
1192
723
func._dbus_is_property = True
1193
724
func._dbus_interface = dbus_interface
1196
727
func._dbus_name = func.__name__
1197
728
if func._dbus_name.endswith("_dbus_property"):
1198
729
func._dbus_name = func._dbus_name[:-14]
1199
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1200
return func
1201
1202
return decorator
1203
1204
1205
def dbus_interface_annotations(dbus_interface):
1206
"""Decorator for marking functions returning interface annotations
1207
1208
Usage:
1209
1210
@dbus_interface_annotations("org.example.Interface")
1211
def _foo(self): # Function name does not matter
1212
return {"org.freedesktop.DBus.Deprecated": "true",
1213
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1214
"false"}
1215
"""
1216
1217
def decorator(func):
1218
func._dbus_is_interface = True
1219
func._dbus_interface = dbus_interface
1220
func._dbus_name = dbus_interface
1221
return func
1222
1223
return decorator
1224
1225
1226
def dbus_annotations(annotations):
1227
"""Decorator to annotate D-Bus methods, signals or properties
1228
Usage:
1229
1230
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1231
"org.freedesktop.DBus.Property."
1232
"EmitsChangedSignal": "false"})
1233
@dbus_service_property("org.example.Interface", signature="b",
1234
access="r")
1235
def Property_dbus_property(self):
1236
return dbus.Boolean(False)
1237
1238
See also the DBusObjectWithAnnotations class.
1239
"""
1240
1241
def decorator(func):
1242
func._dbus_annotations = annotations
1243
return func
1244
730
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
731
return func
1245
732
return decorator
1246
733
1247
734
1248
735
class DBusPropertyException(dbus.exceptions.DBusException):
1249
736
"""A base class for D-Bus property-related exceptions
1250
737
"""
1251
pass
738
def __unicode__(self):
739
return unicode(str(self))
1252
740
1253
741
1254
742
class DBusPropertyAccessException(DBusPropertyException):
1263
751
pass
1264
752
1265
753
1266
class DBusObjectWithAnnotations(dbus.service.Object):
1267
"""A D-Bus object with annotations.
1268
1269
Classes inheriting from this can use the dbus_annotations
1270
decorator to add annotations to methods or signals.
1271
"""
1272
1273
@staticmethod
1274
def _is_dbus_thing(thing):
1275
"""Returns a function testing if an attribute is a D-Bus thing
1276
1277
If called like _is_dbus_thing("method") it returns a function
1278
suitable for use as predicate to inspect.getmembers().
1279
"""
1280
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1281
False)
1282
1283
def _get_all_dbus_things(self, thing):
1284
"""Returns a generator of (name, attribute) pairs
1285
"""
1286
return ((getattr(athing.__get__(self), "_dbus_name", name),
1287
athing.__get__(self))
1288
for cls in self.__class__.__mro__
1289
for name, athing in
1290
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1291
1292
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1293
out_signature="s",
1294
path_keyword='object_path',
1295
connection_keyword='connection')
1296
def Introspect(self, object_path, connection):
1297
"""Overloading of standard D-Bus method.
1298
1299
Inserts annotation tags on methods and signals.
1300
"""
1301
xmlstring = dbus.service.Object.Introspect(self, object_path,
1302
connection)
1303
try:
1304
document = xml.dom.minidom.parseString(xmlstring)
1305
1306
for if_tag in document.getElementsByTagName("interface"):
1307
# Add annotation tags
1308
for typ in ("method", "signal"):
1309
for tag in if_tag.getElementsByTagName(typ):
1310
annots = dict()
1311
for name, prop in (self.
1312
_get_all_dbus_things(typ)):
1313
if (name == tag.getAttribute("name")
1314
and prop._dbus_interface
1315
== if_tag.getAttribute("name")):
1316
annots.update(getattr(
1317
prop, "_dbus_annotations", {}))
1318
for name, value in annots.items():
1319
ann_tag = document.createElement(
1320
"annotation")
1321
ann_tag.setAttribute("name", name)
1322
ann_tag.setAttribute("value", value)
1323
tag.appendChild(ann_tag)
1324
# Add interface annotation tags
1325
for annotation, value in dict(
1326
itertools.chain.from_iterable(
1327
annotations().items()
1328
for name, annotations
1329
in self._get_all_dbus_things("interface")
1330
if name == if_tag.getAttribute("name")
1331
)).items():
1332
ann_tag = document.createElement("annotation")
1333
ann_tag.setAttribute("name", annotation)
1334
ann_tag.setAttribute("value", value)
1335
if_tag.appendChild(ann_tag)
1336
# Fix argument name for the Introspect method itself
1337
if (if_tag.getAttribute("name")
1338
== dbus.INTROSPECTABLE_IFACE):
1339
for cn in if_tag.getElementsByTagName("method"):
1340
if cn.getAttribute("name") == "Introspect":
1341
for arg in cn.getElementsByTagName("arg"):
1342
if (arg.getAttribute("direction")
1343
== "out"):
1344
arg.setAttribute("name",
1345
"xml_data")
1346
xmlstring = document.toxml("utf-8")
1347
document.unlink()
1348
except (AttributeError, xml.dom.DOMException,
1349
xml.parsers.expat.ExpatError) as error:
1350
logger.error("Failed to override Introspection method",
1351
exc_info=error)
1352
return xmlstring
1353
1354
1355
class DBusObjectWithProperties(DBusObjectWithAnnotations):
754
class DBusObjectWithProperties(dbus.service.Object):
1356
755
"""A D-Bus object with properties.
1357
756
1358
757
Classes inheriting from this can use the dbus_service_property
1359
758
decorator to expose methods as D-Bus properties. It exposes the
1360
759
standard Get(), Set(), and GetAll() methods on the D-Bus.
1361
760
"""
1362
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
1363
774
def _get_dbus_property(self, interface_name, property_name):
1364
775
"""Returns a bound method if one exists which is a D-Bus
1365
776
property with the specified name and interface.
1366
777
"""
1367
for cls in self.__class__.__mro__:
1368
for name, value in inspect.getmembers(
1369
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)):
1370
781
if (value._dbus_name == property_name
1371
782
and value._dbus_interface == interface_name):
1372
783
return value.__get__(self)
1373
784
1374
785
# No such property
1375
raise DBusPropertyNotFound("{}:{}.{}".format(
1376
self.dbus_object_path, interface_name, property_name))
1377
1378
@classmethod
1379
def _get_all_interface_names(cls):
1380
"""Get a sequence of all interfaces supported by an object"""
1381
return (name for name in set(getattr(getattr(x, attr),
1382
"_dbus_interface", None)
1383
for x in (inspect.getmro(cls))
1384
for attr in dir(x))
1385
if name is not None)
1386
1387
@dbus.service.method(dbus.PROPERTIES_IFACE,
1388
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",
1389
791
out_signature="v")
1390
792
def Get(self, interface_name, property_name):
1391
793
"""Standard D-Bus property Get() method, see D-Bus standard.
1397
799
if not hasattr(value, "variant_level"):
1398
800
return value
1399
801
return type(value)(value, variant_level=value.variant_level+1)
1400
802
1401
803
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1402
804
def Set(self, interface_name, property_name, value):
1403
805
"""Standard D-Bus property Set() method, see D-Bus standard.
1409
811
# The byte_arrays option is not supported yet on
1410
812
# signatures other than "ay".
1411
813
if prop._dbus_signature != "ay":
1412
raise ValueError("Byte arrays not supported for non-"
1413
"'ay' signature {!r}"
1414
.format(prop._dbus_signature))
1415
value = dbus.ByteArray(b''.join(chr(byte)
1416
for byte in value))
814
raise ValueError
815
value = dbus.ByteArray(''.join(unichr(byte)
816
for byte in value))
1417
817
prop(value)
1418
1419
@dbus.service.method(dbus.PROPERTIES_IFACE,
1420
in_signature="s",
818
819
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1421
820
out_signature="a{sv}")
1422
821
def GetAll(self, interface_name):
1423
822
"""Standard D-Bus property GetAll() method, see D-Bus
1424
823
standard.
1425
824
1426
825
Note: Will not include properties with access="write".
1427
826
"""
1428
827
properties = {}
1429
for name, prop in self._get_all_dbus_things("property"):
828
for name, prop in self._get_all_dbus_properties():
1430
829
if (interface_name
1431
830
and interface_name != prop._dbus_interface):
1432
831
# Interface non-empty but did not match
1438
837
if not hasattr(value, "variant_level"):
1439
838
properties[name] = value
1440
839
continue
1441
properties[name] = type(value)(
1442
value, variant_level=value.variant_level + 1)
840
properties[name] = type(value)(value, variant_level=
841
value.variant_level+1)
1443
842
return dbus.Dictionary(properties, signature="sv")
1444
1445
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1446
def PropertiesChanged(self, interface_name, changed_properties,
1447
invalidated_properties):
1448
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1449
standard.
1450
"""
1451
pass
1452
843
1453
844
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1454
845
out_signature="s",
1455
846
path_keyword='object_path',
1456
847
connection_keyword='connection')
1457
848
def Introspect(self, object_path, connection):
1458
"""Overloading of standard D-Bus method.
1459
1460
Inserts property tags and interface annotation tags.
849
"""Standard D-Bus method, overloaded to insert property tags.
1461
850
"""
1462
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1463
object_path,
1464
connection)
851
xmlstring = dbus.service.Object.Introspect(self, object_path,
852
connection)
1465
853
try:
1466
854
document = xml.dom.minidom.parseString(xmlstring)
1467
1468
855
def make_tag(document, name, prop):
1469
856
e = document.createElement("property")
1470
857
e.setAttribute("name", name)
1471
858
e.setAttribute("type", prop._dbus_signature)
1472
859
e.setAttribute("access", prop._dbus_access)
1473
860
return e
1474
1475
861
for if_tag in document.getElementsByTagName("interface"):
1476
# Add property tags
1477
862
for tag in (make_tag(document, name, prop)
1478
863
for name, prop
1479
in self._get_all_dbus_things("property")
864
in self._get_all_dbus_properties()
1480
865
if prop._dbus_interface
1481
866
== if_tag.getAttribute("name")):
1482
867
if_tag.appendChild(tag)
1483
# Add annotation tags for properties
1484
for tag in if_tag.getElementsByTagName("property"):
1485
annots = dict()
1486
for name, prop in self._get_all_dbus_things(
1487
"property"):
1488
if (name == tag.getAttribute("name")
1489
and prop._dbus_interface
1490
== if_tag.getAttribute("name")):
1491
annots.update(getattr(
1492
prop, "_dbus_annotations", {}))
1493
for name, value in annots.items():
1494
ann_tag = document.createElement(
1495
"annotation")
1496
ann_tag.setAttribute("name", name)
1497
ann_tag.setAttribute("value", value)
1498
tag.appendChild(ann_tag)
1499
868
# Add the names to the return values for the
1500
869
# "org.freedesktop.DBus.Properties" methods
1501
870
if (if_tag.getAttribute("name")
1516
885
except (AttributeError, xml.dom.DOMException,
1517
886
xml.parsers.expat.ExpatError) as error:
1518
887
logger.error("Failed to override Introspection method",
1519
exc_info=error)
1520
return xmlstring
1521
1522
1523
try:
1524
dbus.OBJECT_MANAGER_IFACE
1525
except AttributeError:
1526
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1527
1528
1529
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1530
"""A D-Bus object with an ObjectManager.
1531
1532
Classes inheriting from this exposes the standard
1533
GetManagedObjects call and the InterfacesAdded and
1534
InterfacesRemoved signals on the standard
1535
"org.freedesktop.DBus.ObjectManager" interface.
1536
1537
Note: No signals are sent automatically; they must be sent
1538
manually.
1539
"""
1540
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1541
out_signature="a{oa{sa{sv}}}")
1542
def GetManagedObjects(self):
1543
"""This function must be overridden"""
1544
raise NotImplementedError()
1545
1546
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1547
signature="oa{sa{sv}}")
1548
def InterfacesAdded(self, object_path, interfaces_and_properties):
1549
pass
1550
1551
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1552
def InterfacesRemoved(self, object_path, interfaces):
1553
pass
1554
1555
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1556
out_signature="s",
1557
path_keyword='object_path',
1558
connection_keyword='connection')
1559
def Introspect(self, object_path, connection):
1560
"""Overloading of standard D-Bus method.
1561
1562
Override return argument name of GetManagedObjects to be
1563
"objpath_interfaces_and_properties"
1564
"""
1565
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1566
object_path,
1567
connection)
1568
try:
1569
document = xml.dom.minidom.parseString(xmlstring)
1570
1571
for if_tag in document.getElementsByTagName("interface"):
1572
# Fix argument name for the GetManagedObjects method
1573
if (if_tag.getAttribute("name")
1574
== dbus.OBJECT_MANAGER_IFACE):
1575
for cn in if_tag.getElementsByTagName("method"):
1576
if (cn.getAttribute("name")
1577
== "GetManagedObjects"):
1578
for arg in cn.getElementsByTagName("arg"):
1579
if (arg.getAttribute("direction")
1580
== "out"):
1581
arg.setAttribute(
1582
"name",
1583
"objpath_interfaces"
1584
"_and_properties")
1585
xmlstring = document.toxml("utf-8")
1586
document.unlink()
1587
except (AttributeError, xml.dom.DOMException,
1588
xml.parsers.expat.ExpatError) as error:
1589
logger.error("Failed to override Introspection method",
1590
exc_info=error)
1591
return xmlstring
1592
1593
1594
def datetime_to_dbus(dt, variant_level=0):
888
error)
889
return xmlstring
890
891
892
def datetime_to_dbus (dt, variant_level=0):
1595
893
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1596
894
if dt is None:
1597
return dbus.String("", variant_level=variant_level)
1598
return dbus.String(dt.isoformat(), variant_level=variant_level)
1599
1600
1601
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1602
"""A class decorator; applied to a subclass of
1603
dbus.service.Object, it will add alternate D-Bus attributes with
1604
interface names according to the "alt_interface_names" mapping.
1605
Usage:
1606
1607
@alternate_dbus_interfaces({"org.example.Interface":
1608
"net.example.AlternateInterface"})
1609
class SampleDBusObject(dbus.service.Object):
1610
@dbus.service.method("org.example.Interface")
1611
def SampleDBusMethod():
1612
pass
1613
1614
The above "SampleDBusMethod" on "SampleDBusObject" will be
1615
reachable via two interfaces: "org.example.Interface" and
1616
"net.example.AlternateInterface", the latter of which will have
1617
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1618
"true", unless "deprecate" is passed with a False value.
1619
1620
This works for methods and signals, and also for D-Bus properties
1621
(from DBusObjectWithProperties) and interfaces (from the
1622
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.
1623
904
"""
1624
1625
def wrapper(cls):
1626
for orig_interface_name, alt_interface_name in (
1627
alt_interface_names.items()):
1628
attr = {}
1629
interface_names = set()
1630
# Go though all attributes of the class
1631
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):
1632
912
# Ignore non-D-Bus attributes, and D-Bus attributes
1633
913
# with the wrong interface name
1634
914
if (not hasattr(attribute, "_dbus_interface")
1635
or not attribute._dbus_interface.startswith(
1636
orig_interface_name)):
915
or not attribute._dbus_interface
916
.startswith("se.recompile.Mandos")):
1637
917
continue
1638
918
# Create an alternate D-Bus interface name based on
1639
919
# the current name
1640
alt_interface = attribute._dbus_interface.replace(
1641
orig_interface_name, alt_interface_name)
1642
interface_names.add(alt_interface)
920
alt_interface = (attribute._dbus_interface
921
.replace("se.recompile.Mandos",
922
"se.bsnet.fukt.Mandos"))
1643
923
# Is this a D-Bus signal?
1644
924
if getattr(attribute, "_dbus_is_signal", False):
1645
# Extract the original non-method undecorated
1646
# function by black magic
1647
if sys.version_info.major == 2:
1648
nonmethod_func = (dict(
925
# Extract the original non-method function by
926
# black magic
927
nonmethod_func = (dict(
1649
928
zip(attribute.func_code.co_freevars,
1650
attribute.__closure__))
1651
["func"].cell_contents)
1652
else:
1653
nonmethod_func = (dict(
1654
zip(attribute.__code__.co_freevars,
1655
attribute.__closure__))
1656
["func"].cell_contents)
929
attribute.__closure__))["func"]
930
.cell_contents)
1657
931
# Create a new, but exactly alike, function
1658
932
# object, and decorate it to be a new D-Bus signal
1659
933
# with the alternate D-Bus interface name
1660
new_function = copy_function(nonmethod_func)
1661
new_function = (dbus.service.signal(
1662
alt_interface,
1663
attribute._dbus_signature)(new_function))
1664
# Copy annotations, if any
1665
try:
1666
new_function._dbus_annotations = dict(
1667
attribute._dbus_annotations)
1668
except AttributeError:
1669
pass
1670
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)))
1671
943
# Define a creator of a function to call both the
1672
# original and alternate functions, so both the
1673
# original and alternate signals gets sent when
1674
# the function is called
944
# old and new functions, so both the old and new
945
# signals gets sent when the function is called
1675
946
def fixscope(func1, func2):
1676
947
"""This function is a scope container to pass
1677
948
func1 and func2 to the "call_both" function
1678
949
outside of its arguments"""
1679
1680
@functools.wraps(func2)
1681
950
def call_both(*args, **kwargs):
1682
951
"""This function will emit two D-Bus
1683
952
signals by calling func1 and func2"""
1684
953
func1(*args, **kwargs)
1685
954
func2(*args, **kwargs)
1686
# Make wrapper function look like a D-Bus
1687
# signal
1688
for name, attr in inspect.getmembers(func2):
1689
if name.startswith("_dbus_"):
1690
setattr(call_both, name, attr)
1691
1692
955
return call_both
1693
956
# Create the "call_both" function and add it to
1694
957
# the class
1695
attr[attrname] = fixscope(attribute, new_function)
958
attr[attrname] = fixscope(attribute,
959
new_function)
1696
960
# Is this a D-Bus method?
1697
961
elif getattr(attribute, "_dbus_is_method", False):
1698
962
# Create a new, but exactly alike, function
1699
963
# object. Decorate it to be a new D-Bus method
1700
964
# with the alternate D-Bus interface name. Add it
1701
965
# to the class.
1702
attr[attrname] = (
1703
dbus.service.method(
1704
alt_interface,
1705
attribute._dbus_in_signature,
1706
attribute._dbus_out_signature)
1707
(copy_function(attribute)))
1708
# Copy annotations, if any
1709
try:
1710
attr[attrname]._dbus_annotations = dict(
1711
attribute._dbus_annotations)
1712
except AttributeError:
1713
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)))
1714
976
# Is this a D-Bus property?
1715
977
elif getattr(attribute, "_dbus_is_property", False):
1716
978
# Create a new, but exactly alike, function
1717
979
# object, and decorate it to be a new D-Bus
1718
980
# property with the alternate D-Bus interface
1719
981
# name. Add it to the class.
1720
attr[attrname] = (dbus_service_property(
1721
alt_interface, attribute._dbus_signature,
1722
attribute._dbus_access,
1723
attribute._dbus_get_args_options
1724
["byte_arrays"])
1725
(copy_function(attribute)))
1726
# Copy annotations, if any
1727
try:
1728
attr[attrname]._dbus_annotations = dict(
1729
attribute._dbus_annotations)
1730
except AttributeError:
1731
pass
1732
# Is this a D-Bus interface?
1733
elif getattr(attribute, "_dbus_is_interface", False):
1734
# Create a new, but exactly alike, function
1735
# object. Decorate it to be a new D-Bus interface
1736
# with the alternate D-Bus interface name. Add it
1737
# to the class.
1738
attr[attrname] = (
1739
dbus_interface_annotations(alt_interface)
1740
(copy_function(attribute)))
1741
if deprecate:
1742
# Deprecate all alternate interfaces
1743
iname = "_AlternateDBusNames_interface_annotation{}"
1744
for interface_name in interface_names:
1745
1746
@dbus_interface_annotations(interface_name)
1747
def func(self):
1748
return {"org.freedesktop.DBus.Deprecated":
1749
"true"}
1750
# Find an unused name
1751
for aname in (iname.format(i)
1752
for i in itertools.count()):
1753
if aname not in attr:
1754
attr[aname] = func
1755
break
1756
if interface_names:
1757
# Replace the class with a new subclass of it with
1758
# methods, signals, etc. as created above.
1759
if sys.version_info.major == 2:
1760
cls = type(b"{}Alternate".format(cls.__name__),
1761
(cls, ), attr)
1762
else:
1763
cls = type("{}Alternate".format(cls.__name__),
1764
(cls, ), attr)
1765
return cls
1766
1767
return wrapper
1768
1769
1770
@alternate_dbus_interfaces({"se.recompile.Mandos":
1771
"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
1772
998
class ClientDBus(Client, DBusObjectWithProperties):
1773
999
"""A Client class using D-Bus
1774
1000
1775
1001
Attributes:
1776
1002
dbus_object_path: dbus.ObjectPath
1777
1003
bus: dbus.SystemBus()
1778
1004
"""
1779
1005
1780
1006
runtime_expansions = (Client.runtime_expansions
1781
+ ("dbus_object_path", ))
1782
1783
_interface = "se.recompile.Mandos.Client"
1784
1007
+ ("dbus_object_path",))
1008
1785
1009
# dbus.service.Object doesn't use super(), so we can't either.
1786
1787
def __init__(self, bus=None, *args, **kwargs):
1010
1011
def __init__(self, bus = None, *args, **kwargs):
1788
1012
self.bus = bus
1789
1013
Client.__init__(self, *args, **kwargs)
1014
1015
self._approvals_pending = 0
1790
1016
# Only now, when this client is initialized, can it show up on
1791
1017
# the D-Bus
1792
client_object_name = str(self.name).translate(
1018
client_object_name = unicode(self.name).translate(
1793
1019
{ord("."): ord("_"),
1794
1020
ord("-"): ord("_")})
1795
self.dbus_object_path = dbus.ObjectPath(
1796
"/clients/" + client_object_name)
1021
self.dbus_object_path = (dbus.ObjectPath
1022
("/clients/" + client_object_name))
1797
1023
DBusObjectWithProperties.__init__(self, self.bus,
1798
1024
self.dbus_object_path)
1799
1800
def notifychangeproperty(transform_func, dbus_name,
1801
type_func=lambda x: x,
1802
variant_level=1,
1803
invalidate_only=False,
1804
_interface=_interface):
1025
1026
def notifychangeproperty(transform_func,
1027
dbus_name, type_func=lambda x: x,
1028
variant_level=1):
1805
1029
""" Modify a variable so that it's a property which announces
1806
1030
its changes to DBus.
1807
1031
1808
1032
transform_fun: Function that takes a value and a variant_level
1809
1033
and transforms it to a D-Bus type.
1810
1034
dbus_name: D-Bus name of the variable
1812
1036
to the D-Bus. Default: no transform
1813
1037
variant_level: D-Bus variant level. Default: 1
1814
1038
"""
1815
attrname = "_{}".format(dbus_name)
1816
1039
attrname = "_{0}".format(dbus_name)
1817
1040
def setter(self, value):
1818
1041
if hasattr(self, "dbus_object_path"):
1819
1042
if (not hasattr(self, attrname) or
1820
1043
type_func(getattr(self, attrname, None))
1821
1044
!= type_func(value)):
1822
if invalidate_only:
1823
self.PropertiesChanged(
1824
_interface, dbus.Dictionary(),
1825
dbus.Array((dbus_name, )))
1826
else:
1827
dbus_value = transform_func(
1828
type_func(value),
1829
variant_level=variant_level)
1830
self.PropertyChanged(dbus.String(dbus_name),
1831
dbus_value)
1832
self.PropertiesChanged(
1833
_interface,
1834
dbus.Dictionary({dbus.String(dbus_name):
1835
dbus_value}),
1836
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)
1837
1050
setattr(self, attrname, value)
1838
1051
1839
1052
return property(lambda self: getattr(self, attrname), setter)
1840
1053
1054
1841
1055
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1842
1056
approvals_pending = notifychangeproperty(dbus.Boolean,
1843
1057
"ApprovalPending",
1844
type_func=bool)
1058
type_func = bool)
1845
1059
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1846
1060
last_enabled = notifychangeproperty(datetime_to_dbus,
1847
1061
"LastEnabled")
1848
checker = notifychangeproperty(
1849
dbus.Boolean, "CheckerRunning",
1850
type_func=lambda checker: checker is not None)
1062
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1063
type_func = lambda checker:
1064
checker is not None)
1851
1065
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1852
1066
"LastCheckedOK")
1853
last_checker_status = notifychangeproperty(dbus.Int16,
1854
"LastCheckerStatus")
1855
1067
last_approval_request = notifychangeproperty(
1856
1068
datetime_to_dbus, "LastApprovalRequest")
1857
1069
approved_by_default = notifychangeproperty(dbus.Boolean,
1858
1070
"ApprovedByDefault")
1859
approval_delay = notifychangeproperty(
1860
dbus.UInt64, "ApprovalDelay",
1861
type_func=lambda td: td.total_seconds() * 1000)
1071
approval_delay = notifychangeproperty(dbus.UInt16,
1072
"ApprovalDelay",
1073
type_func =
1074
_timedelta_to_milliseconds)
1862
1075
approval_duration = notifychangeproperty(
1863
dbus.UInt64, "ApprovalDuration",
1864
type_func=lambda td: td.total_seconds() * 1000)
1076
dbus.UInt16, "ApprovalDuration",
1077
type_func = _timedelta_to_milliseconds)
1865
1078
host = notifychangeproperty(dbus.String, "Host")
1866
timeout = notifychangeproperty(
1867
dbus.UInt64, "Timeout",
1868
type_func=lambda td: td.total_seconds() * 1000)
1079
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1080
type_func =
1081
_timedelta_to_milliseconds)
1869
1082
extended_timeout = notifychangeproperty(
1870
dbus.UInt64, "ExtendedTimeout",
1871
type_func=lambda td: td.total_seconds() * 1000)
1872
interval = notifychangeproperty(
1873
dbus.UInt64, "Interval",
1874
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)
1875
1089
checker_command = notifychangeproperty(dbus.String, "Checker")
1876
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1877
invalidate_only=True)
1878
1090
1879
1091
del notifychangeproperty
1880
1092
1881
1093
def __del__(self, *args, **kwargs):
1882
1094
try:
1883
1095
self.remove_from_connection()
1886
1098
if hasattr(DBusObjectWithProperties, "__del__"):
1887
1099
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1888
1100
Client.__del__(self, *args, **kwargs)
1889
1890
def checker_callback(self, source, condition,
1891
connection, command, *args, **kwargs):
1892
ret = Client.checker_callback(self, source, condition,
1893
connection, command, *args,
1894
**kwargs)
1895
exitstatus = self.last_checker_status
1896
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)
1897
1108
# Emit D-Bus signal
1898
1109
self.CheckerCompleted(dbus.Int16(exitstatus),
1899
# This is specific to GNU libC
1900
dbus.Int64(exitstatus << 8),
1110
dbus.Int64(condition),
1901
1111
dbus.String(command))
1902
1112
else:
1903
1113
# Emit D-Bus signal
1904
1114
self.CheckerCompleted(dbus.Int16(-1),
1905
dbus.Int64(
1906
# This is specific to GNU libC
1907
(exitstatus << 8)
1908
| self.last_checker_signal),
1115
dbus.Int64(condition),
1909
1116
dbus.String(command))
1910
return ret
1911
1117
1118
return Client.checker_callback(self, pid, condition, command,
1119
*args, **kwargs)
1120
1912
1121
def start_checker(self, *args, **kwargs):
1913
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
1914
1127
r = Client.start_checker(self, *args, **kwargs)
1915
1128
# Only if new checker process was started
1916
1129
if (self.checker is not None
1918
1131
# Emit D-Bus signal
1919
1132
self.CheckerStarted(self.current_checker_command)
1920
1133
return r
1921
1134
1922
1135
def _reset_approved(self):
1923
self.approved = None
1136
self._approved = None
1924
1137
return False
1925
1138
1926
1139
def approve(self, value=True):
1927
self.approved = value
1928
GLib.timeout_add(int(self.approval_duration.total_seconds()
1929
* 1000), self._reset_approved)
1930
1140
self.send_changedstate()
1931
1932
# D-Bus methods, signals & properties
1933
1934
# Interfaces
1935
1936
# Signals
1937
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
1938
1152
# CheckerCompleted - signal
1939
1153
@dbus.service.signal(_interface, signature="nxs")
1940
1154
def CheckerCompleted(self, exitcode, waitstatus, command):
1941
1155
"D-Bus signal"
1942
1156
pass
1943
1157
1944
1158
# CheckerStarted - signal
1945
1159
@dbus.service.signal(_interface, signature="s")
1946
1160
def CheckerStarted(self, command):
1947
1161
"D-Bus signal"
1948
1162
pass
1949
1163
1950
1164
# PropertyChanged - signal
1951
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1952
1165
@dbus.service.signal(_interface, signature="sv")
1953
1166
def PropertyChanged(self, property, value):
1954
1167
"D-Bus signal"
1955
1168
pass
1956
1169
1957
1170
# GotSecret - signal
1958
1171
@dbus.service.signal(_interface)
1959
1172
def GotSecret(self):
1962
1175
server to mandos-client
1963
1176
"""
1964
1177
pass
1965
1178
1966
1179
# Rejected - signal
1967
1180
@dbus.service.signal(_interface, signature="s")
1968
1181
def Rejected(self, reason):
1969
1182
"D-Bus signal"
1970
1183
pass
1971
1184
1972
1185
# NeedApproval - signal
1973
1186
@dbus.service.signal(_interface, signature="tb")
1974
1187
def NeedApproval(self, timeout, default):
1975
1188
"D-Bus signal"
1976
1189
return self.need_approval()
1977
1978
# Methods
1979
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
1980
1201
# Approve - method
1981
1202
@dbus.service.method(_interface, in_signature="b")
1982
1203
def Approve(self, value):
1983
1204
self.approve(value)
1984
1205
1985
1206
# CheckedOK - method
1986
1207
@dbus.service.method(_interface)
1987
1208
def CheckedOK(self):
1988
1209
self.checked_ok()
1989
1210
1990
1211
# Enable - method
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1992
1212
@dbus.service.method(_interface)
1993
1213
def Enable(self):
1994
1214
"D-Bus method"
1995
1215
self.enable()
1996
1216
1997
1217
# StartChecker - method
1998
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1999
1218
@dbus.service.method(_interface)
2000
1219
def StartChecker(self):
2001
1220
"D-Bus method"
2002
1221
self.start_checker()
2003
1222
2004
1223
# Disable - method
2005
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2006
1224
@dbus.service.method(_interface)
2007
1225
def Disable(self):
2008
1226
"D-Bus method"
2009
1227
self.disable()
2010
1228
2011
1229
# StopChecker - method
2012
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2013
1230
@dbus.service.method(_interface)
2014
1231
def StopChecker(self):
2015
1232
self.stop_checker()
2016
2017
# Properties
2018
1233
1234
## Properties
1235
2019
1236
# ApprovalPending - property
2020
1237
@dbus_service_property(_interface, signature="b", access="read")
2021
1238
def ApprovalPending_dbus_property(self):
2022
1239
return dbus.Boolean(bool(self.approvals_pending))
2023
1240
2024
1241
# ApprovedByDefault - property
2025
@dbus_service_property(_interface,
2026
signature="b",
1242
@dbus_service_property(_interface, signature="b",
2027
1243
access="readwrite")
2028
1244
def ApprovedByDefault_dbus_property(self, value=None):
2029
1245
if value is None: # get
2030
1246
return dbus.Boolean(self.approved_by_default)
2031
1247
self.approved_by_default = bool(value)
2032
1248
2033
1249
# ApprovalDelay - property
2034
@dbus_service_property(_interface,
2035
signature="t",
1250
@dbus_service_property(_interface, signature="t",
2036
1251
access="readwrite")
2037
1252
def ApprovalDelay_dbus_property(self, value=None):
2038
1253
if value is None: # get
2039
return dbus.UInt64(self.approval_delay.total_seconds()
2040
* 1000)
1254
return dbus.UInt64(self.approval_delay_milliseconds())
2041
1255
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2042
1256
2043
1257
# ApprovalDuration - property
2044
@dbus_service_property(_interface,
2045
signature="t",
1258
@dbus_service_property(_interface, signature="t",
2046
1259
access="readwrite")
2047
1260
def ApprovalDuration_dbus_property(self, value=None):
2048
1261
if value is None: # get
2049
return dbus.UInt64(self.approval_duration.total_seconds()
2050
* 1000)
1262
return dbus.UInt64(_timedelta_to_milliseconds(
1263
self.approval_duration))
2051
1264
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2052
1265
2053
1266
# Name - property
2054
@dbus_annotations(
2055
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2056
1267
@dbus_service_property(_interface, signature="s", access="read")
2057
1268
def Name_dbus_property(self):
2058
1269
return dbus.String(self.name)
2059
2060
# KeyID - property
2061
@dbus_annotations(
2062
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2063
@dbus_service_property(_interface, signature="s", access="read")
2064
def KeyID_dbus_property(self):
2065
return dbus.String(self.key_id)
2066
1270
2067
1271
# Fingerprint - property
2068
@dbus_annotations(
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
1272
@dbus_service_property(_interface, signature="s", access="read")
2071
1273
def Fingerprint_dbus_property(self):
2072
1274
return dbus.String(self.fingerprint)
2073
1275
2074
1276
# Host - property
2075
@dbus_service_property(_interface,
2076
signature="s",
1277
@dbus_service_property(_interface, signature="s",
2077
1278
access="readwrite")
2078
1279
def Host_dbus_property(self, value=None):
2079
1280
if value is None: # get
2080
1281
return dbus.String(self.host)
2081
self.host = str(value)
2082
1282
self.host = value
1283
2083
1284
# Created - property
2084
@dbus_annotations(
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
1285
@dbus_service_property(_interface, signature="s", access="read")
2087
1286
def Created_dbus_property(self):
2088
1287
return datetime_to_dbus(self.created)
2089
1288
2090
1289
# LastEnabled - property
2091
1290
@dbus_service_property(_interface, signature="s", access="read")
2092
1291
def LastEnabled_dbus_property(self):
2093
1292
return datetime_to_dbus(self.last_enabled)
2094
1293
2095
1294
# Enabled - property
2096
@dbus_service_property(_interface,
2097
signature="b",
1295
@dbus_service_property(_interface, signature="b",
2098
1296
access="readwrite")
2099
1297
def Enabled_dbus_property(self, value=None):
2100
1298
if value is None: # get
2103
1301
self.enable()
2104
1302
else:
2105
1303
self.disable()
2106
1304
2107
1305
# LastCheckedOK - property
2108
@dbus_service_property(_interface,
2109
signature="s",
1306
@dbus_service_property(_interface, signature="s",
2110
1307
access="readwrite")
2111
1308
def LastCheckedOK_dbus_property(self, value=None):
2112
1309
if value is not None:
2113
1310
self.checked_ok()
2114
1311
return
2115
1312
return datetime_to_dbus(self.last_checked_ok)
2116
2117
# LastCheckerStatus - property
2118
@dbus_service_property(_interface, signature="n", access="read")
2119
def LastCheckerStatus_dbus_property(self):
2120
return dbus.Int16(self.last_checker_status)
2121
1313
2122
1314
# Expires - property
2123
1315
@dbus_service_property(_interface, signature="s", access="read")
2124
1316
def Expires_dbus_property(self):
2125
1317
return datetime_to_dbus(self.expires)
2126
1318
2127
1319
# LastApprovalRequest - property
2128
1320
@dbus_service_property(_interface, signature="s", access="read")
2129
1321
def LastApprovalRequest_dbus_property(self):
2130
1322
return datetime_to_dbus(self.last_approval_request)
2131
1323
2132
1324
# Timeout - property
2133
@dbus_service_property(_interface,
2134
signature="t",
1325
@dbus_service_property(_interface, signature="t",
2135
1326
access="readwrite")
2136
1327
def Timeout_dbus_property(self, value=None):
2137
1328
if value is None: # get
2138
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2139
old_timeout = self.timeout
1329
return dbus.UInt64(self.timeout_milliseconds())
2140
1330
self.timeout = datetime.timedelta(0, 0, 0, value)
2141
# Reschedule disabling
2142
if self.enabled:
2143
now = datetime.datetime.utcnow()
2144
self.expires += self.timeout - old_timeout
2145
if self.expires <= now:
2146
# The timeout has passed
2147
self.disable()
2148
else:
2149
if (getattr(self, "disable_initiator_tag", None)
2150
is None):
2151
return
2152
GLib.source_remove(self.disable_initiator_tag)
2153
self.disable_initiator_tag = GLib.timeout_add(
2154
int((self.expires - now).total_seconds() * 1000),
2155
self.disable)
2156
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
2157
1352
# ExtendedTimeout - property
2158
@dbus_service_property(_interface,
2159
signature="t",
1353
@dbus_service_property(_interface, signature="t",
2160
1354
access="readwrite")
2161
1355
def ExtendedTimeout_dbus_property(self, value=None):
2162
1356
if value is None: # get
2163
return dbus.UInt64(self.extended_timeout.total_seconds()
2164
* 1000)
1357
return dbus.UInt64(self.extended_timeout_milliseconds())
2165
1358
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2166
1359
2167
1360
# Interval - property
2168
@dbus_service_property(_interface,
2169
signature="t",
1361
@dbus_service_property(_interface, signature="t",
2170
1362
access="readwrite")
2171
1363
def Interval_dbus_property(self, value=None):
2172
1364
if value is None: # get
2173
return dbus.UInt64(self.interval.total_seconds() * 1000)
1365
return dbus.UInt64(self.interval_milliseconds())
2174
1366
self.interval = datetime.timedelta(0, 0, 0, value)
2175
1367
if getattr(self, "checker_initiator_tag", None) is None:
2176
1368
return
2177
1369
if self.enabled:
2178
1370
# Reschedule checker run
2179
GLib.source_remove(self.checker_initiator_tag)
2180
self.checker_initiator_tag = GLib.timeout_add(
2181
value, self.start_checker)
2182
self.start_checker() # Start one now, too
2183
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
2184
1376
# Checker - property
2185
@dbus_service_property(_interface,
2186
signature="s",
1377
@dbus_service_property(_interface, signature="s",
2187
1378
access="readwrite")
2188
1379
def Checker_dbus_property(self, value=None):
2189
1380
if value is None: # get
2190
1381
return dbus.String(self.checker_command)
2191
self.checker_command = str(value)
2192
1382
self.checker_command = value
1383
2193
1384
# CheckerRunning - property
2194
@dbus_service_property(_interface,
2195
signature="b",
1385
@dbus_service_property(_interface, signature="b",
2196
1386
access="readwrite")
2197
1387
def CheckerRunning_dbus_property(self, value=None):
2198
1388
if value is None: # get
2201
1391
self.start_checker()
2202
1392
else:
2203
1393
self.stop_checker()
2204
1394
2205
1395
# ObjectPath - property
2206
@dbus_annotations(
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2208
"org.freedesktop.DBus.Deprecated": "true"})
2209
1396
@dbus_service_property(_interface, signature="o", access="read")
2210
1397
def ObjectPath_dbus_property(self):
2211
return self.dbus_object_path # is already a dbus.ObjectPath
2212
1398
return self.dbus_object_path # is already a dbus.ObjectPath
1399
2213
1400
# Secret = property
2214
@dbus_annotations(
2215
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2216
"invalidates"})
2217
@dbus_service_property(_interface,
2218
signature="ay",
2219
access="write",
2220
byte_arrays=True)
1401
@dbus_service_property(_interface, signature="ay",
1402
access="write", byte_arrays=True)
2221
1403
def Secret_dbus_property(self, value):
2222
self.secret = bytes(value)
2223
1404
self.secret = str(value)
1405
2224
1406
del _interface
2225
1407
2226
1408
2227
class ProxyClient:
2228
def __init__(self, child_pipe, key_id, fpr, address):
1409
class ProxyClient(object):
1410
def __init__(self, child_pipe, fpr, address):
2229
1411
self._pipe = child_pipe
2230
self._pipe.send(('init', key_id, fpr, address))
1412
self._pipe.send(('init', fpr, address))
2231
1413
if not self._pipe.recv():
2232
raise KeyError(key_id or fpr)
2233
1414
raise KeyError()
1415
2234
1416
def __getattribute__(self, name):
2235
if name == '_pipe':
1417
if(name == '_pipe'):
2236
1418
return super(ProxyClient, self).__getattribute__(name)
2237
1419
self._pipe.send(('getattr', name))
2238
1420
data = self._pipe.recv()
2239
1421
if data[0] == 'data':
2240
1422
return data[1]
2241
1423
if data[0] == 'function':
2242
2243
1424
def func(*args, **kwargs):
2244
1425
self._pipe.send(('funcall', name, args, kwargs))
2245
1426
return self._pipe.recv()[1]
2246
2247
1427
return func
2248
1428
2249
1429
def __setattr__(self, name, value):
2250
if name == '_pipe':
1430
if(name == '_pipe'):
2251
1431
return super(ProxyClient, self).__setattr__(name, value)
2252
1432
self._pipe.send(('setattr', name, value))
2253
1433
2254
1434
1435
class ClientDBusTransitional(ClientDBus):
1436
__metaclass__ = AlternateDBusNamesMetaclass
1437
1438
2255
1439
class ClientHandler(socketserver.BaseRequestHandler, object):
2256
1440
"""A class to handle client connections.
2257
1441
2258
1442
Instantiated once for each connection to handle it.
2259
1443
Note: This will run in its own forked process."""
2260
1444
2261
1445
def handle(self):
2262
1446
with contextlib.closing(self.server.child_pipe) as child_pipe:
2263
1447
logger.info("TCP connection from: %s",
2264
str(self.client_address))
1448
unicode(self.client_address))
2265
1449
logger.debug("Pipe FD: %d",
2266
1450
self.server.child_pipe.fileno())
2267
2268
session = gnutls.ClientSession(self.request)
2269
2270
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2271
# "+AES-256-CBC", "+SHA1",
2272
# "+COMP-NULL", "+CTYPE-OPENPGP",
2273
# "+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"))
2274
1466
# Use a fallback default, since this MUST be set.
2275
1467
priority = self.server.gnutls_priority
2276
1468
if priority is None:
2277
1469
priority = "NORMAL"
2278
gnutls.priority_set_direct(session._c_object,
2279
priority.encode("utf-8"),
2280
None)
2281
1470
(gnutls.library.functions
1471
.gnutls_priority_set_direct(session._c_object,
1472
priority, None))
1473
2282
1474
# Start communication using the Mandos protocol
2283
1475
# Get protocol number
2284
1476
line = self.request.makefile().readline()
2285
1477
logger.debug("Protocol version: %r", line)
2286
1478
try:
2287
1479
if int(line.strip().split()[0]) > 1:
2288
raise RuntimeError(line)
1480
raise RuntimeError
2289
1481
except (ValueError, IndexError, RuntimeError) as error:
2290
1482
logger.error("Unknown protocol version: %s", error)
2291
1483
return
2292
1484
2293
1485
# Start GnuTLS connection
2294
1486
try:
2295
1487
session.handshake()
2296
except gnutls.Error as error:
1488
except gnutls.errors.GNUTLSError as error:
2297
1489
logger.warning("Handshake failed: %s", error)
2298
1490
# Do not run session.bye() here: the session is not
2299
1491
# established. Just abandon the request.
2300
1492
return
2301
1493
logger.debug("Handshake succeeded")
2302
1494
2303
1495
approval_required = False
2304
1496
try:
2305
if gnutls.has_rawpk:
2306
fpr = b""
2307
try:
2308
key_id = self.key_id(
2309
self.peer_certificate(session))
2310
except (TypeError, gnutls.Error) as error:
2311
logger.warning("Bad certificate: %s", error)
2312
return
2313
logger.debug("Key ID: %s", key_id)
2314
2315
else:
2316
key_id = b""
2317
try:
2318
fpr = self.fingerprint(
2319
self.peer_certificate(session))
2320
except (TypeError, gnutls.Error) as error:
2321
logger.warning("Bad certificate: %s", error)
2322
return
2323
logger.debug("Fingerprint: %s", fpr)
2324
2325
try:
2326
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,
2327
1511
self.client_address)
2328
1512
except KeyError:
2329
1513
return
2330
1514
2331
1515
if client.approval_delay:
2332
1516
delay = client.approval_delay
2333
1517
client.approvals_pending += 1
2334
1518
approval_required = True
2335
1519
2336
1520
while True:
2337
1521
if not client.enabled:
2338
1522
logger.info("Client %s is disabled",
2339
client.name)
1523
client.name)
2340
1524
if self.server.use_dbus:
2341
1525
# Emit D-Bus signal
2342
1526
client.Rejected("Disabled")
2343
1527
return
2344
2345
if client.approved or not client.approval_delay:
2346
# 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
2347
1531
break
2348
elif client.approved is None:
1532
elif client._approved is None:
2349
1533
logger.info("Client %s needs approval",
2350
1534
client.name)
2351
1535
if self.server.use_dbus:
2352
1536
# Emit D-Bus signal
2353
1537
client.NeedApproval(
2354
client.approval_delay.total_seconds()
2355
* 1000, client.approved_by_default)
1538
client.approval_delay_milliseconds(),
1539
client.approved_by_default)
2356
1540
else:
2357
1541
logger.warning("Client %s was not approved",
2358
1542
client.name)
2360
1544
# Emit D-Bus signal
2361
1545
client.Rejected("Denied")
2362
1546
return
2363
2364
# wait until timeout or approved
1547
1548
#wait until timeout or approved
2365
1549
time = datetime.datetime.now()
2366
1550
client.changedstate.acquire()
2367
client.changedstate.wait(delay.total_seconds())
1551
(client.changedstate.wait
1552
(float(client._timedelta_to_milliseconds(delay)
1553
/ 1000)))
2368
1554
client.changedstate.release()
2369
1555
time2 = datetime.datetime.now()
2370
1556
if (time2 - time) >= delay:
2380
1566
break
2381
1567
else:
2382
1568
delay -= time2 - time
2383
2384
try:
2385
session.send(client.secret)
2386
except gnutls.Error as error:
2387
logger.warning("gnutls send failed",
2388
exc_info=error)
2389
return
2390
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
2391
1582
logger.info("Sending secret to %s", client.name)
2392
1583
# bump the timeout using extended_timeout
2393
client.bump_timeout(client.extended_timeout)
1584
client.checked_ok(client.extended_timeout)
2394
1585
if self.server.use_dbus:
2395
1586
# Emit D-Bus signal
2396
1587
client.GotSecret()
2397
1588
2398
1589
finally:
2399
1590
if approval_required:
2400
1591
client.approvals_pending -= 1
2401
1592
try:
2402
1593
session.bye()
2403
except gnutls.Error as error:
2404
logger.warning("GnuTLS bye failed",
2405
exc_info=error)
2406
1594
except gnutls.errors.GNUTLSError as error:
1595
logger.warning("GnuTLS bye failed")
1596
2407
1597
@staticmethod
2408
1598
def peer_certificate(session):
2409
"Return the peer's certificate as a bytestring"
2410
try:
2411
cert_type = gnutls.certificate_type_get2(session._c_object,
2412
gnutls.CTYPE_PEERS)
2413
except AttributeError:
2414
cert_type = gnutls.certificate_type_get(session._c_object)
2415
if gnutls.has_rawpk:
2416
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2417
else:
2418
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2419
# If not a valid certificate type...
2420
if cert_type not in valid_cert_types:
2421
logger.info("Cert type %r not in %r", cert_type,
2422
valid_cert_types)
2423
# ...return invalid data
2424
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
2425
1606
list_size = ctypes.c_uint(1)
2426
cert_list = (gnutls.certificate_get_peers
1607
cert_list = (gnutls.library.functions
1608
.gnutls_certificate_get_peers
2427
1609
(session._c_object, ctypes.byref(list_size)))
2428
1610
if not bool(cert_list) and list_size.value != 0:
2429
raise gnutls.Error("error getting peer certificate")
1611
raise gnutls.errors.GNUTLSError("error getting peer"
1612
" certificate")
2430
1613
if list_size.value == 0:
2431
1614
return None
2432
1615
cert = cert_list[0]
2433
1616
return ctypes.string_at(cert.data, cert.size)
2434
2435
@staticmethod
2436
def key_id(certificate):
2437
"Convert a certificate bytestring to a hexdigit key ID"
2438
# New GnuTLS "datum" with the public key
2439
datum = gnutls.datum_t(
2440
ctypes.cast(ctypes.c_char_p(certificate),
2441
ctypes.POINTER(ctypes.c_ubyte)),
2442
ctypes.c_uint(len(certificate)))
2443
# XXX all these need to be created in the gnutls "module"
2444
# New empty GnuTLS certificate
2445
pubkey = gnutls.pubkey_t()
2446
gnutls.pubkey_init(ctypes.byref(pubkey))
2447
# Import the raw public key into the certificate
2448
gnutls.pubkey_import(pubkey,
2449
ctypes.byref(datum),
2450
gnutls.X509_FMT_DER)
2451
# New buffer for the key ID
2452
buf = ctypes.create_string_buffer(32)
2453
buf_len = ctypes.c_size_t(len(buf))
2454
# Get the key ID from the raw public key into the buffer
2455
gnutls.pubkey_get_key_id(pubkey,
2456
gnutls.KEYID_USE_SHA256,
2457
ctypes.cast(ctypes.byref(buf),
2458
ctypes.POINTER(ctypes.c_ubyte)),
2459
ctypes.byref(buf_len))
2460
# Deinit the certificate
2461
gnutls.pubkey_deinit(pubkey)
2462
2463
# Convert the buffer to a Python bytestring
2464
key_id = ctypes.string_at(buf, buf_len.value)
2465
# Convert the bytestring to hexadecimal notation
2466
hex_key_id = binascii.hexlify(key_id).upper()
2467
return hex_key_id
2468
1617
2469
1618
@staticmethod
2470
1619
def fingerprint(openpgp):
2471
1620
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2472
1621
# New GnuTLS "datum" with the OpenPGP public key
2473
datum = gnutls.datum_t(
2474
ctypes.cast(ctypes.c_char_p(openpgp),
2475
ctypes.POINTER(ctypes.c_ubyte)),
2476
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))))
2477
1627
# New empty GnuTLS certificate
2478
crt = gnutls.openpgp_crt_t()
2479
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)))
2480
1631
# Import the OpenPGP public key into the certificate
2481
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2482
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))
2483
1636
# Verify the self signature in the key
2484
1637
crtverify = ctypes.c_uint()
2485
gnutls.openpgp_crt_verify_self(crt, 0,
2486
ctypes.byref(crtverify))
1638
(gnutls.library.functions
1639
.gnutls_openpgp_crt_verify_self(crt, 0,
1640
ctypes.byref(crtverify)))
2487
1641
if crtverify.value != 0:
2488
gnutls.openpgp_crt_deinit(crt)
2489
raise gnutls.CertificateSecurityError(code
2490
=crtverify.value)
1642
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1643
raise (gnutls.errors.CertificateSecurityError
1644
("Verify failed"))
2491
1645
# New buffer for the fingerprint
2492
1646
buf = ctypes.create_string_buffer(20)
2493
1647
buf_len = ctypes.c_size_t()
2494
1648
# Get the fingerprint from the certificate into the buffer
2495
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2496
ctypes.byref(buf_len))
1649
(gnutls.library.functions
1650
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1651
ctypes.byref(buf_len)))
2497
1652
# Deinit the certificate
2498
gnutls.openpgp_crt_deinit(crt)
1653
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2499
1654
# Convert the buffer to a Python bytestring
2500
1655
fpr = ctypes.string_at(buf, buf_len.value)
2501
1656
# Convert the bytestring to hexadecimal notation
2503
1658
return hex_fpr
2504
1659
2505
1660
2506
class MultiprocessingMixIn:
1661
class MultiprocessingMixIn(object):
2507
1662
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2508
2509
1663
def sub_process_main(self, request, address):
2510
1664
try:
2511
1665
self.finish_request(request, address)
2512
except Exception:
1666
except:
2513
1667
self.handle_error(request, address)
2514
1668
self.close_request(request)
2515
1669
2516
1670
def process_request(self, request, address):
2517
1671
"""Start a new process to process the request."""
2518
proc = multiprocessing.Process(target=self.sub_process_main,
2519
args=(request, address))
1672
proc = multiprocessing.Process(target = self.sub_process_main,
1673
args = (request,
1674
address))
2520
1675
proc.start()
2521
1676
return proc
2522
1677
2523
1678
2524
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1679
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2525
1680
""" adds a pipe to the MixIn """
2526
2527
1681
def process_request(self, request, client_address):
2528
1682
"""Overrides and wraps the original process_request().
2529
1683
2530
1684
This function creates a new pipe in self.pipe
2531
1685
"""
2532
1686
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2533
1687
2534
1688
proc = MultiprocessingMixIn.process_request(self, request,
2535
1689
client_address)
2536
1690
self.child_pipe.close()
2537
1691
self.add_pipe(parent_pipe, proc)
2538
1692
2539
1693
def add_pipe(self, parent_pipe, proc):
2540
1694
"""Dummy function; override as necessary"""
2541
raise NotImplementedError()
1695
raise NotImplementedError
2542
1696
2543
1697
2544
1698
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2545
socketserver.TCPServer):
1699
socketserver.TCPServer, object):
2546
1700
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2547
1701
2548
1702
Attributes:
2549
1703
enabled: Boolean; whether this server is activated yet
2550
1704
interface: None or a network interface name (string)
2551
1705
use_ipv6: Boolean; to use IPv6 or not
2552
1706
"""
2553
2554
1707
def __init__(self, server_address, RequestHandlerClass,
2555
interface=None,
2556
use_ipv6=True,
2557
socketfd=None):
2558
"""If socketfd is set, use that file descriptor instead of
2559
creating a new one with socket.socket().
2560
"""
1708
interface=None, use_ipv6=True):
2561
1709
self.interface = interface
2562
1710
if use_ipv6:
2563
1711
self.address_family = socket.AF_INET6
2564
if socketfd is not None:
2565
# Save the file descriptor
2566
self.socketfd = socketfd
2567
# Save the original socket.socket() function
2568
self.socket_socket = socket.socket
2569
2570
# To implement --socket, we monkey patch socket.socket.
2571
#
2572
# (When socketserver.TCPServer is a new-style class, we
2573
# could make self.socket into a property instead of monkey
2574
# patching socket.socket.)
2575
#
2576
# Create a one-time-only replacement for socket.socket()
2577
@functools.wraps(socket.socket)
2578
def socket_wrapper(*args, **kwargs):
2579
# Restore original function so subsequent calls are
2580
# not affected.
2581
socket.socket = self.socket_socket
2582
del self.socket_socket
2583
# This time only, return a new socket object from the
2584
# saved file descriptor.
2585
return socket.fromfd(self.socketfd, *args, **kwargs)
2586
# Replace socket.socket() function with wrapper
2587
socket.socket = socket_wrapper
2588
# The socketserver.TCPServer.__init__ will call
2589
# socket.socket(), which might be our replacement,
2590
# socket_wrapper(), if socketfd was set.
2591
1712
socketserver.TCPServer.__init__(self, server_address,
2592
1713
RequestHandlerClass)
2593
2594
1714
def server_bind(self):
2595
1715
"""This overrides the normal server_bind() function
2596
1716
to bind to an interface if one was specified, and also NOT to
2597
1717
bind to an address or port if they were not specified."""
2598
global SO_BINDTODEVICE
2599
1718
if self.interface is not None:
2600
1719
if SO_BINDTODEVICE is None:
2601
# Fall back to a hard-coded value which seems to be
2602
# common enough.
2603
logger.warning("SO_BINDTODEVICE not found, trying 25")
2604
SO_BINDTODEVICE = 25
2605
try:
2606
self.socket.setsockopt(
2607
socket.SOL_SOCKET, SO_BINDTODEVICE,
2608
(self.interface + "\0").encode("utf-8"))
2609
except socket.error as error:
2610
if error.errno == errno.EPERM:
2611
logger.error("No permission to bind to"
2612
" interface %s", self.interface)
2613
elif error.errno == errno.ENOPROTOOPT:
2614
logger.error("SO_BINDTODEVICE not available;"
2615
" cannot bind to interface %s",
2616
self.interface)
2617
elif error.errno == errno.ENODEV:
2618
logger.error("Interface %s does not exist,"
2619
" cannot bind", self.interface)
2620
else:
2621
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
2622
1740
# Only bind(2) the socket if we really need to.
2623
1741
if self.server_address[0] or self.server_address[1]:
2624
if self.server_address[1]:
2625
self.allow_reuse_address = True
2626
1742
if not self.server_address[0]:
2627
1743
if self.address_family == socket.AF_INET6:
2628
any_address = "::" # in6addr_any
1744
any_address = "::" # in6addr_any
2629
1745
else:
2630
any_address = "0.0.0.0" # INADDR_ANY
1746
any_address = socket.INADDR_ANY
2631
1747
self.server_address = (any_address,
2632
1748
self.server_address[1])
2633
1749
elif not self.server_address[1]:
2634
self.server_address = (self.server_address[0], 0)
1750
self.server_address = (self.server_address[0],
1751
0)
2635
1752
# if self.interface:
2636
1753
# self.server_address = (self.server_address[0],
2637
1754
# 0, # port
2643
1760
2644
1761
class MandosServer(IPv6_TCPServer):
2645
1762
"""Mandos server.
2646
1763
2647
1764
Attributes:
2648
1765
clients: set of Client objects
2649
1766
gnutls_priority GnuTLS priority string
2650
1767
use_dbus: Boolean; to emit D-Bus signals or not
2651
2652
Assumes a GLib.MainLoop event loop.
1768
1769
Assumes a gobject.MainLoop event loop.
2653
1770
"""
2654
2655
1771
def __init__(self, server_address, RequestHandlerClass,
2656
interface=None,
2657
use_ipv6=True,
2658
clients=None,
2659
gnutls_priority=None,
2660
use_dbus=True,
2661
socketfd=None):
1772
interface=None, use_ipv6=True, clients=None,
1773
gnutls_priority=None, use_dbus=True):
2662
1774
self.enabled = False
2663
1775
self.clients = clients
2664
1776
if self.clients is None:
2667
1779
self.gnutls_priority = gnutls_priority
2668
1780
IPv6_TCPServer.__init__(self, server_address,
2669
1781
RequestHandlerClass,
2670
interface=interface,
2671
use_ipv6=use_ipv6,
2672
socketfd=socketfd)
2673
1782
interface = interface,
1783
use_ipv6 = use_ipv6)
2674
1784
def server_activate(self):
2675
1785
if self.enabled:
2676
1786
return socketserver.TCPServer.server_activate(self)
2677
1787
2678
1788
def enable(self):
2679
1789
self.enabled = True
2680
1790
2681
1791
def add_pipe(self, parent_pipe, proc):
2682
1792
# Call "handle_ipc" for both data and EOF events
2683
GLib.io_add_watch(
2684
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2685
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2686
functools.partial(self.handle_ipc,
2687
parent_pipe=parent_pipe,
2688
proc=proc))
2689
2690
def handle_ipc(self, source, condition,
2691
parent_pipe=None,
2692
proc=None,
2693
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)
2694
1816
# error, or the other end of multiprocessing.Pipe has closed
2695
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1817
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2696
1818
# Wait for other process to exit
2697
1819
proc.join()
2698
1820
return False
2699
1821
2700
1822
# Read a request from the child
2701
1823
request = parent_pipe.recv()
2702
1824
command = request[0]
2703
1825
2704
1826
if command == 'init':
2705
key_id = request[1].decode("ascii")
2706
fpr = request[2].decode("ascii")
2707
address = request[3]
2708
2709
for c in self.clients.values():
2710
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2711
continue
2712
if key_id and c.key_id == key_id:
2713
client = c
2714
break
2715
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:
2716
1832
client = c
2717
1833
break
2718
1834
else:
2719
logger.info("Client not found for key ID: %s, address"
2720
": %s", key_id or fpr, address)
1835
logger.info("Client not found for fingerprint: %s, ad"
1836
"dress: %s", fpr, address)
2721
1837
if self.use_dbus:
2722
1838
# Emit D-Bus signal
2723
mandos_dbus_service.ClientNotFound(key_id or fpr,
1839
mandos_dbus_service.ClientNotFound(fpr,
2724
1840
address[0])
2725
1841
parent_pipe.send(False)
2726
1842
return False
2727
2728
GLib.io_add_watch(
2729
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2730
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2731
functools.partial(self.handle_ipc,
2732
parent_pipe=parent_pipe,
2733
proc=proc,
2734
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))
2735
1852
parent_pipe.send(True)
2736
1853
# remove the old hook in favor of the new above hook on
2737
1854
# same fileno
2740
1857
funcname = request[1]
2741
1858
args = request[2]
2742
1859
kwargs = request[3]
2743
1860
2744
1861
parent_pipe.send(('data', getattr(client_object,
2745
1862
funcname)(*args,
2746
**kwargs)))
2747
1863
**kwargs)))
1864
2748
1865
if command == 'getattr':
2749
1866
attrname = request[1]
2750
if isinstance(client_object.__getattribute__(attrname),
2751
collections.Callable):
2752
parent_pipe.send(('function', ))
1867
if callable(client_object.__getattribute__(attrname)):
1868
parent_pipe.send(('function',))
2753
1869
else:
2754
parent_pipe.send((
2755
'data', client_object.__getattribute__(attrname)))
2756
1870
parent_pipe.send(('data', client_object
1871
.__getattribute__(attrname)))
1872
2757
1873
if command == 'setattr':
2758
1874
attrname = request[1]
2759
1875
value = request[2]
2760
1876
setattr(client_object, attrname, value)
2761
1877
2762
1878
return True
2763
1879
2764
1880
2765
def rfc3339_duration_to_delta(duration):
2766
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2767
2768
>>> rfc3339_duration_to_delta("P7D")
2769
datetime.timedelta(7)
2770
>>> rfc3339_duration_to_delta("PT60S")
2771
datetime.timedelta(0, 60)
2772
>>> rfc3339_duration_to_delta("PT60M")
2773
datetime.timedelta(0, 3600)
2774
>>> rfc3339_duration_to_delta("PT24H")
2775
datetime.timedelta(1)
2776
>>> rfc3339_duration_to_delta("P1W")
2777
datetime.timedelta(7)
2778
>>> rfc3339_duration_to_delta("PT5M30S")
2779
datetime.timedelta(0, 330)
2780
>>> rfc3339_duration_to_delta("P1DT3M20S")
2781
datetime.timedelta(1, 200)
2782
"""
2783
2784
# Parsing an RFC 3339 duration with regular expressions is not
2785
# possible - there would have to be multiple places for the same
2786
# values, like seconds. The current code, while more esoteric, is
2787
# cleaner without depending on a parsing library. If Python had a
2788
# built-in library for parsing we would use it, but we'd like to
2789
# avoid excessive use of external libraries.
2790
2791
# New type for defining tokens, syntax, and semantics all-in-one
2792
Token = collections.namedtuple("Token", (
2793
"regexp", # To match token; if "value" is not None, must have
2794
# a "group" containing digits
2795
"value", # datetime.timedelta or None
2796
"followers")) # Tokens valid after this token
2797
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2798
# the "duration" ABNF definition in RFC 3339, Appendix A.
2799
token_end = Token(re.compile(r"$"), None, frozenset())
2800
token_second = Token(re.compile(r"(\d+)S"),
2801
datetime.timedelta(seconds=1),
2802
frozenset((token_end, )))
2803
token_minute = Token(re.compile(r"(\d+)M"),
2804
datetime.timedelta(minutes=1),
2805
frozenset((token_second, token_end)))
2806
token_hour = Token(re.compile(r"(\d+)H"),
2807
datetime.timedelta(hours=1),
2808
frozenset((token_minute, token_end)))
2809
token_time = Token(re.compile(r"T"),
2810
None,
2811
frozenset((token_hour, token_minute,
2812
token_second)))
2813
token_day = Token(re.compile(r"(\d+)D"),
2814
datetime.timedelta(days=1),
2815
frozenset((token_time, token_end)))
2816
token_month = Token(re.compile(r"(\d+)M"),
2817
datetime.timedelta(weeks=4),
2818
frozenset((token_day, token_end)))
2819
token_year = Token(re.compile(r"(\d+)Y"),
2820
datetime.timedelta(weeks=52),
2821
frozenset((token_month, token_end)))
2822
token_week = Token(re.compile(r"(\d+)W"),
2823
datetime.timedelta(weeks=1),
2824
frozenset((token_end, )))
2825
token_duration = Token(re.compile(r"P"), None,
2826
frozenset((token_year, token_month,
2827
token_day, token_time,
2828
token_week)))
2829
# Define starting values:
2830
# Value so far
2831
value = datetime.timedelta()
2832
found_token = None
2833
# Following valid tokens
2834
followers = frozenset((token_duration, ))
2835
# String left to parse
2836
s = duration
2837
# Loop until end token is found
2838
while found_token is not token_end:
2839
# Search for any currently valid tokens
2840
for token in followers:
2841
match = token.regexp.match(s)
2842
if match is not None:
2843
# Token found
2844
if token.value is not None:
2845
# Value found, parse digits
2846
factor = int(match.group(1), 10)
2847
# Add to value so far
2848
value += factor * token.value
2849
# Strip token from string
2850
s = token.regexp.sub("", s, 1)
2851
# Go to found token
2852
found_token = token
2853
# Set valid next tokens
2854
followers = found_token.followers
2855
break
2856
else:
2857
# No currently valid tokens were found
2858
raise ValueError("Invalid RFC 3339 duration: {!r}"
2859
.format(duration))
2860
# End token found
2861
return value
2862
2863
2864
1881
def string_to_delta(interval):
2865
1882
"""Parse a string and return a datetime.timedelta
2866
1883
2867
1884
>>> string_to_delta('7d')
2868
1885
datetime.timedelta(7)
2869
1886
>>> string_to_delta('60s')
2877
1894
>>> string_to_delta('5m 30s')
2878
1895
datetime.timedelta(0, 330)
2879
1896
"""
2880
2881
try:
2882
return rfc3339_duration_to_delta(interval)
2883
except ValueError:
2884
pass
2885
2886
1897
timevalue = datetime.timedelta(0)
2887
1898
for s in interval.split():
2888
1899
try:
2889
suffix = s[-1]
1900
suffix = unicode(s[-1])
2890
1901
value = int(s[:-1])
2891
1902
if suffix == "d":
2892
1903
delta = datetime.timedelta(value)
2899
1910
elif suffix == "w":
2900
1911
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2901
1912
else:
2902
raise ValueError("Unknown suffix {!r}".format(suffix))
2903
except IndexError as e:
1913
raise ValueError("Unknown suffix %r" % suffix)
1914
except (ValueError, IndexError) as e:
2904
1915
raise ValueError(*(e.args))
2905
1916
timevalue += delta
2906
1917
return timevalue
2907
1918
2908
1919
2909
def daemon(nochdir=False, noclose=False):
1920
def daemon(nochdir = False, noclose = False):
2910
1921
"""See daemon(3). Standard BSD Unix function.
2911
1922
2912
1923
This should really exist as os.daemon, but it doesn't (yet)."""
2913
1924
if os.fork():
2914
1925
sys.exit()
2919
1930
sys.exit()
2920
1931
if not noclose:
2921
1932
# Close all standard open file descriptors
2922
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1933
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2923
1934
if not stat.S_ISCHR(os.fstat(null).st_mode):
2924
1935
raise OSError(errno.ENODEV,
2925
"{} not a character device"
2926
.format(os.devnull))
1936
"%s not a character device"
1937
% os.path.devnull)
2927
1938
os.dup2(null, sys.stdin.fileno())
2928
1939
os.dup2(null, sys.stdout.fileno())
2929
1940
os.dup2(null, sys.stderr.fileno())
2932
1943
2933
1944
2934
1945
def main():
2935
1946
2936
1947
##################################################################
2937
1948
# Parsing of options, both command line and config file
2938
1949
2939
1950
parser = argparse.ArgumentParser()
2940
1951
parser.add_argument("-v", "--version", action="version",
2941
version="%(prog)s {}".format(version),
1952
version = "%%(prog)s %s" % version,
2942
1953
help="show version number and exit")
2943
1954
parser.add_argument("-i", "--interface", metavar="IF",
2944
1955
help="Bind to interface IF")
2950
1961
help="Run self-test")
2951
1962
parser.add_argument("--debug", action="store_true",
2952
1963
help="Debug mode; run in foreground and log"
2953
" to terminal", default=None)
1964
" to terminal")
2954
1965
parser.add_argument("--debuglevel", metavar="LEVEL",
2955
1966
help="Debug level for stdout output")
2956
1967
parser.add_argument("--priority", help="GnuTLS"
2963
1974
" files")
2964
1975
parser.add_argument("--no-dbus", action="store_false",
2965
1976
dest="use_dbus", help="Do not provide D-Bus"
2966
" system bus interface", default=None)
1977
" system bus interface")
2967
1978
parser.add_argument("--no-ipv6", action="store_false",
2968
dest="use_ipv6", help="Do not use IPv6",
2969
default=None)
1979
dest="use_ipv6", help="Do not use IPv6")
2970
1980
parser.add_argument("--no-restore", action="store_false",
2971
1981
dest="restore", help="Do not restore stored"
2972
" state", default=None)
2973
parser.add_argument("--socket", type=int,
2974
help="Specify a file descriptor to a network"
2975
" socket to use instead of creating one")
1982
" state")
2976
1983
parser.add_argument("--statedir", metavar="DIR",
2977
1984
help="Directory to save/restore state in")
2978
parser.add_argument("--foreground", action="store_true",
2979
help="Run in foreground", default=None)
2980
parser.add_argument("--no-zeroconf", action="store_false",
2981
dest="zeroconf", help="Do not use Zeroconf",
2982
default=None)
2983
1985
2984
1986
options = parser.parse_args()
2985
1987
1988
if options.check:
1989
import doctest
1990
doctest.testmod()
1991
sys.exit()
1992
2986
1993
# Default values for config file for server-global settings
2987
if gnutls.has_rawpk:
2988
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2989
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2990
else:
2991
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2992
":+SIGN-DSA-SHA256")
2993
server_defaults = {"interface": "",
2994
"address": "",
2995
"port": "",
2996
"debug": "False",
2997
"priority": priority,
2998
"servicename": "Mandos",
2999
"use_dbus": "True",
3000
"use_ipv6": "True",
3001
"debuglevel": "",
3002
"restore": "True",
3003
"socket": "",
3004
"statedir": "/var/lib/mandos",
3005
"foreground": "False",
3006
"zeroconf": "True",
3007
}
3008
del priority
3009
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
3010
2008
# Parse config file for server-global settings
3011
server_config = configparser.ConfigParser(server_defaults)
2009
server_config = configparser.SafeConfigParser(server_defaults)
3012
2010
del server_defaults
3013
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3014
# 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
3015
2014
server_settings = server_config.defaults()
3016
2015
# Use the appropriate methods on the non-string config options
3017
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3018
"foreground", "zeroconf"):
2016
for option in ("debug", "use_dbus", "use_ipv6"):
3019
2017
server_settings[option] = server_config.getboolean("DEFAULT",
3020
2018
option)
3021
2019
if server_settings["port"]:
3022
2020
server_settings["port"] = server_config.getint("DEFAULT",
3023
2021
"port")
3024
if server_settings["socket"]:
3025
server_settings["socket"] = server_config.getint("DEFAULT",
3026
"socket")
3027
# Later, stdin will, and stdout and stderr might, be dup'ed
3028
# over with an opened os.devnull. But we don't want this to
3029
# happen with a supplied network socket.
3030
if 0 <= server_settings["socket"] <= 2:
3031
server_settings["socket"] = os.dup(server_settings
3032
["socket"])
3033
2022
del server_config
3034
2023
3035
2024
# Override the settings from the config file with command line
3036
2025
# options, if set.
3037
2026
for option in ("interface", "address", "port", "debug",
3038
"priority", "servicename", "configdir", "use_dbus",
3039
"use_ipv6", "debuglevel", "restore", "statedir",
3040
"socket", "foreground", "zeroconf"):
2027
"priority", "servicename", "configdir",
2028
"use_dbus", "use_ipv6", "debuglevel", "restore",
2029
"statedir"):
3041
2030
value = getattr(options, option)
3042
2031
if value is not None:
3043
2032
server_settings[option] = value
3044
2033
del options
3045
2034
# Force all strings to be unicode
3046
2035
for option in server_settings.keys():
3047
if isinstance(server_settings[option], bytes):
3048
server_settings[option] = (server_settings[option]
3049
.decode("utf-8"))
3050
# Force all boolean options to be boolean
3051
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3052
"foreground", "zeroconf"):
3053
server_settings[option] = bool(server_settings[option])
3054
# Debug implies foreground
3055
if server_settings["debug"]:
3056
server_settings["foreground"] = True
2036
if type(server_settings[option]) is str:
2037
server_settings[option] = unicode(server_settings[option])
3057
2038
# Now we have our good server settings in "server_settings"
3058
2039
3059
2040
##################################################################
3060
3061
if (not server_settings["zeroconf"]
3062
and not (server_settings["port"]
3063
or server_settings["socket"] != "")):
3064
parser.error("Needs port or socket to work without Zeroconf")
3065
2041
3066
2042
# For convenience
3067
2043
debug = server_settings["debug"]
3068
2044
debuglevel = server_settings["debuglevel"]
3070
2046
use_ipv6 = server_settings["use_ipv6"]
3071
2047
stored_state_path = os.path.join(server_settings["statedir"],
3072
2048
stored_state_file)
3073
foreground = server_settings["foreground"]
3074
zeroconf = server_settings["zeroconf"]
3075
2049
3076
2050
if debug:
3077
initlogger(debug, logging.DEBUG)
2051
initlogger(logging.DEBUG)
3078
2052
else:
3079
2053
if not debuglevel:
3080
initlogger(debug)
2054
initlogger()
3081
2055
else:
3082
2056
level = getattr(logging, debuglevel.upper())
3083
initlogger(debug, level)
3084
2057
initlogger(level)
2058
3085
2059
if server_settings["servicename"] != "Mandos":
3086
syslogger.setFormatter(
3087
logging.Formatter('Mandos ({}) [%(process)d]:'
3088
' %(levelname)s: %(message)s'.format(
3089
server_settings["servicename"])))
3090
2060
syslogger.setFormatter(logging.Formatter
2061
('Mandos (%s) [%%(process)d]:'
2062
' %%(levelname)s: %%(message)s'
2063
% server_settings["servicename"]))
2064
3091
2065
# Parse config file with clients
3092
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)
3093
2075
client_config.read(os.path.join(server_settings["configdir"],
3094
2076
"clients.conf"))
3095
2077
3096
2078
global mandos_dbus_service
3097
2079
mandos_dbus_service = None
3098
3099
socketfd = None
3100
if server_settings["socket"] != "":
3101
socketfd = server_settings["socket"]
3102
tcp_server = MandosServer(
3103
(server_settings["address"], server_settings["port"]),
3104
ClientHandler,
3105
interface=(server_settings["interface"] or None),
3106
use_ipv6=use_ipv6,
3107
gnutls_priority=server_settings["priority"],
3108
use_dbus=use_dbus,
3109
socketfd=socketfd)
3110
if not foreground:
3111
pidfilename = "/run/mandos.pid"
3112
if not os.path.isdir("/run/."):
3113
pidfilename = "/var/run/mandos.pid"
3114
pidfile = None
3115
try:
3116
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3117
except IOError as e:
3118
logger.error("Could not open file %r", pidfilename,
3119
exc_info=e)
3120
3121
for name, group in (("_mandos", "_mandos"),
3122
("mandos", "mandos"),
3123
("nobody", "nogroup")):
3124
try:
3125
uid = pwd.getpwnam(name).pw_uid
3126
gid = pwd.getpwnam(group).pw_gid
3127
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
3128
2104
except KeyError:
3129
continue
3130
else:
3131
uid = 65534
3132
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
3133
2111
try:
3134
2112
os.setgid(gid)
3135
2113
os.setuid(uid)
3136
if debug:
3137
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3138
gid))
3139
2114
except OSError as error:
3140
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3141
.format(uid, gid, os.strerror(error.errno)))
3142
if error.errno != errno.EPERM:
3143
raise
3144
2115
if error[0] != errno.EPERM:
2116
raise error
2117
3145
2118
if debug:
3146
2119
# Enable all possible GnuTLS debugging
3147
2120
3148
2121
# "Use a log level over 10 to enable all debugging options."
3149
2122
# - GnuTLS manual
3150
gnutls.global_set_log_level(11)
3151
3152
@gnutls.log_func
2123
gnutls.library.functions.gnutls_global_set_log_level(11)
2124
2125
@gnutls.library.types.gnutls_log_func
3153
2126
def debug_gnutls(level, string):
3154
2127
logger.debug("GnuTLS: %s", string[:-1])
3155
3156
gnutls.global_set_log_function(debug_gnutls)
3157
2128
2129
(gnutls.library.functions
2130
.gnutls_global_set_log_function(debug_gnutls))
2131
3158
2132
# Redirect stdin so all checkers get /dev/null
3159
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2133
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3160
2134
os.dup2(null, sys.stdin.fileno())
3161
2135
if null > 2:
3162
2136
os.close(null)
3163
2137
else:
2138
# No console logging
2139
logger.removeHandler(console)
2140
3164
2141
# Need to fork before connecting to D-Bus
3165
if not foreground:
2142
if not debug:
3166
2143
# Close all input and output, do double fork, etc.
3167
2144
daemon()
3168
3169
if gi.version_info < (3, 10, 2):
3170
# multiprocessing will use threads, so before we use GLib we
3171
# need to inform GLib that threads will be used.
3172
GLib.threads_init()
3173
2145
3174
2146
global main_loop
3175
2147
# From the Avahi example code
3176
DBusGMainLoop(set_as_default=True)
3177
main_loop = GLib.MainLoop()
2148
DBusGMainLoop(set_as_default=True )
2149
main_loop = gobject.MainLoop()
3178
2150
bus = dbus.SystemBus()
3179
2151
# End of Avahi example code
3180
2152
if use_dbus:
3181
2153
try:
3182
2154
bus_name = dbus.service.BusName("se.recompile.Mandos",
3183
bus,
3184
do_not_queue=True)
3185
old_bus_name = dbus.service.BusName(
3186
"se.bsnet.fukt.Mandos", bus,
3187
do_not_queue=True)
3188
except dbus.exceptions.DBusException as e:
3189
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")
3190
2161
use_dbus = False
3191
2162
server_settings["use_dbus"] = False
3192
2163
tcp_server.use_dbus = False
3193
if zeroconf:
3194
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3195
service = AvahiServiceToSyslog(
3196
name=server_settings["servicename"],
3197
servicetype="_mandos._tcp",
3198
protocol=protocol,
3199
bus=bus)
3200
if server_settings["interface"]:
3201
service.interface = if_nametoindex(
3202
server_settings["interface"].encode("utf-8"))
3203
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
3204
2173
global multiprocessing_manager
3205
2174
multiprocessing_manager = multiprocessing.Manager()
3206
2175
3207
2176
client_class = Client
3208
2177
if use_dbus:
3209
client_class = functools.partial(ClientDBus, bus=bus)
3210
3211
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
3212
2204
old_client_settings = {}
3213
clients_data = {}
3214
3215
# This is used to redirect stdout and stderr for checker processes
3216
global wnull
3217
wnull = open(os.devnull, "w") # A writable /dev/null
3218
# Only used if server is running in foreground but not in debug
3219
# mode
3220
if debug or not foreground:
3221
wnull.close()
3222
2205
clients_data = []
2206
3223
2207
# Get client data and settings from last running state.
3224
2208
if server_settings["restore"]:
3225
2209
try:
3226
2210
with open(stored_state_path, "rb") as stored_state:
3227
if sys.version_info.major == 2:
3228
clients_data, old_client_settings = pickle.load(
3229
stored_state)
3230
else:
3231
bytes_clients_data, bytes_old_client_settings = (
3232
pickle.load(stored_state, encoding="bytes"))
3233
# Fix bytes to strings
3234
# clients_data
3235
# .keys()
3236
clients_data = {(key.decode("utf-8")
3237
if isinstance(key, bytes)
3238
else key): value
3239
for key, value in
3240
bytes_clients_data.items()}
3241
del bytes_clients_data
3242
for key in clients_data:
3243
value = {(k.decode("utf-8")
3244
if isinstance(k, bytes) else k): v
3245
for k, v in
3246
clients_data[key].items()}
3247
clients_data[key] = value
3248
# .client_structure
3249
value["client_structure"] = [
3250
(s.decode("utf-8")
3251
if isinstance(s, bytes)
3252
else s) for s in
3253
value["client_structure"]]
3254
# .name & .host
3255
for k in ("name", "host"):
3256
if isinstance(value[k], bytes):
3257
value[k] = value[k].decode("utf-8")
3258
if "key_id" not in value:
3259
value["key_id"] = ""
3260
elif "fingerprint" not in value:
3261
value["fingerprint"] = ""
3262
# old_client_settings
3263
# .keys()
3264
old_client_settings = {
3265
(key.decode("utf-8")
3266
if isinstance(key, bytes)
3267
else key): value
3268
for key, value in
3269
bytes_old_client_settings.items()}
3270
del bytes_old_client_settings
3271
# .host
3272
for value in old_client_settings.values():
3273
if isinstance(value["host"], bytes):
3274
value["host"] = (value["host"]
3275
.decode("utf-8"))
2211
clients_data, old_client_settings = (pickle.load
2212
(stored_state))
3276
2213
os.remove(stored_state_path)
3277
2214
except IOError as e:
3278
if e.errno == errno.ENOENT:
3279
logger.warning("Could not load persistent state:"
3280
" {}".format(os.strerror(e.errno)))
3281
else:
3282
logger.critical("Could not load persistent state:",
3283
exc_info=e)
2215
logger.warning("Could not load persistent state: {0}"
2216
.format(e))
2217
if e.errno != errno.ENOENT:
3284
2218
raise
3285
except EOFError as e:
3286
logger.warning("Could not load persistent state: "
3287
"EOFError:",
3288
exc_info=e)
3289
3290
with PGPEngine() as pgp:
3291
for client_name, client in clients_data.items():
3292
# Skip removed clients
3293
if client_name not in client_settings:
3294
continue
3295
2219
2220
with Crypto() as crypt:
2221
for client in clients_data:
2222
client_name = client["name"]
2223
3296
2224
# Decide which value to use after restoring saved state.
3297
2225
# We have three different values: Old config file,
3298
2226
# new config file, and saved state.
3303
2231
# For each value in new config, check if it
3304
2232
# differs from the old config value (Except for
3305
2233
# the "secret" attribute)
3306
if (name != "secret"
3307
and (value !=
3308
old_client_settings[client_name][name])):
3309
client[name] = value
2234
if (name != "secret" and
2235
value != old_client_settings[client_name]
2236
[name]):
2237
setattr(client, name, value)
3310
2238
except KeyError:
3311
2239
pass
3312
2240
3313
2241
# Clients who has passed its expire date can still be
3314
# enabled if its last checker was successful. A Client
3315
# whose checker succeeded before we stored its state is
3316
# assumed to have successfully run all checkers during
3317
# downtime.
3318
if client["enabled"]:
3319
if datetime.datetime.utcnow() >= client["expires"]:
3320
if not client["last_checked_ok"]:
3321
logger.warning(
3322
"disabling client {} - Client never "
3323
"performed a successful checker".format(
3324
client_name))
3325
client["enabled"] = False
3326
elif client["last_checker_status"] != 0:
3327
logger.warning(
3328
"disabling client {} - Client last"
3329
" checker failed with error code"
3330
" {}".format(
3331
client_name,
3332
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:
3333
2250
client["enabled"] = False
3334
2251
else:
3335
client["expires"] = (
3336
datetime.datetime.utcnow()
3337
+ client["timeout"])
3338
logger.debug("Last checker succeeded,"
3339
" keeping {} enabled".format(
3340
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
3341
2284
try:
3342
client["secret"] = pgp.decrypt(
3343
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 = (
3344
2293
client_settings[client_name]["secret"])
3345
except PGPError:
3346
# If decryption fails, we use secret from new settings
3347
logger.debug("Failed to decrypt {} old secret".format(
3348
client_name))
3349
client["secret"] = (client_settings[client_name]
3350
["secret"])
3351
3352
# Add/remove clients based on new changes made to config
3353
for client_name in (set(old_client_settings)
3354
- set(client_settings)):
3355
del clients_data[client_name]
3356
for client_name in (set(client_settings)
3357
- set(old_client_settings)):
3358
clients_data[client_name] = client_settings[client_name]
3359
3360
# Create all client objects
3361
for client_name, client in clients_data.items():
3362
tcp_server.clients[client_name] = client_class(
3363
name=client_name,
3364
settings=client,
3365
server_settings=server_settings)
3366
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
3367
2305
if not tcp_server.clients:
3368
2306
logger.warning("No clients defined")
3369
3370
if not foreground:
3371
if pidfile is not None:
3372
pid = os.getpid()
3373
try:
3374
with pidfile:
3375
print(pid, file=pidfile)
3376
except IOError:
3377
logger.error("Could not write to file %r with PID %d",
3378
pidfilename, pid)
3379
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
3380
2320
del pidfilename
3381
3382
for termsig in (signal.SIGHUP, signal.SIGTERM):
3383
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3384
lambda: main_loop.quit() and False)
3385
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
3386
2327
if use_dbus:
3387
3388
@alternate_dbus_interfaces(
3389
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3390
class MandosDBusService(DBusObjectWithObjectManager):
2328
class MandosDBusService(dbus.service.Object):
3391
2329
"""A D-Bus proxy object"""
3392
3393
2330
def __init__(self):
3394
2331
dbus.service.Object.__init__(self, bus, "/")
3395
3396
2332
_interface = "se.recompile.Mandos"
3397
2333
3398
2334
@dbus.service.signal(_interface, signature="o")
3399
2335
def ClientAdded(self, objpath):
3400
2336
"D-Bus signal"
3401
2337
pass
3402
2338
3403
2339
@dbus.service.signal(_interface, signature="ss")
3404
def ClientNotFound(self, key_id, address):
2340
def ClientNotFound(self, fingerprint, address):
3405
2341
"D-Bus signal"
3406
2342
pass
3407
3408
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3409
"true"})
2343
3410
2344
@dbus.service.signal(_interface, signature="os")
3411
2345
def ClientRemoved(self, objpath, name):
3412
2346
"D-Bus signal"
3413
2347
pass
3414
3415
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3416
"true"})
2348
3417
2349
@dbus.service.method(_interface, out_signature="ao")
3418
2350
def GetAllClients(self):
3419
2351
"D-Bus method"
3420
return dbus.Array(c.dbus_object_path for c in
3421
tcp_server.clients.values())
3422
3423
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3424
"true"})
2352
return dbus.Array(c.dbus_object_path
2353
for c in
2354
tcp_server.clients.itervalues())
2355
3425
2356
@dbus.service.method(_interface,
3426
2357
out_signature="a{oa{sv}}")
3427
2358
def GetAllClientsWithProperties(self):
3428
2359
"D-Bus method"
3429
2360
return dbus.Dictionary(
3430
{c.dbus_object_path: c.GetAll(
3431
"se.recompile.Mandos.Client")
3432
for c in tcp_server.clients.values()},
2361
((c.dbus_object_path, c.GetAll(""))
2362
for c in tcp_server.clients.itervalues()),
3433
2363
signature="oa{sv}")
3434
2364
3435
2365
@dbus.service.method(_interface, in_signature="o")
3436
2366
def RemoveClient(self, object_path):
3437
2367
"D-Bus method"
3438
for c in tcp_server.clients.values():
2368
for c in tcp_server.clients.itervalues():
3439
2369
if c.dbus_object_path == object_path:
3440
2370
del tcp_server.clients[c.name]
3441
2371
c.remove_from_connection()
3442
# Don't signal the disabling
2372
# Don't signal anything except ClientRemoved
3443
2373
c.disable(quiet=True)
3444
# Emit D-Bus signal for removal
3445
self.client_removed_signal(c)
2374
# Emit D-Bus signal
2375
self.ClientRemoved(object_path, c.name)
3446
2376
return
3447
2377
raise KeyError(object_path)
3448
2378
3449
2379
del _interface
3450
3451
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3452
out_signature="a{oa{sa{sv}}}")
3453
def GetManagedObjects(self):
3454
"""D-Bus method"""
3455
return dbus.Dictionary(
3456
{client.dbus_object_path:
3457
dbus.Dictionary(
3458
{interface: client.GetAll(interface)
3459
for interface in
3460
client._get_all_interface_names()})
3461
for client in tcp_server.clients.values()})
3462
3463
def client_added_signal(self, client):
3464
"""Send the new standard signal and the old signal"""
3465
if use_dbus:
3466
# New standard signal
3467
self.InterfacesAdded(
3468
client.dbus_object_path,
3469
dbus.Dictionary(
3470
{interface: client.GetAll(interface)
3471
for interface in
3472
client._get_all_interface_names()}))
3473
# Old signal
3474
self.ClientAdded(client.dbus_object_path)
3475
3476
def client_removed_signal(self, client):
3477
"""Send the new standard signal and the old signal"""
3478
if use_dbus:
3479
# New standard signal
3480
self.InterfacesRemoved(
3481
client.dbus_object_path,
3482
client._get_all_interface_names())
3483
# Old signal
3484
self.ClientRemoved(client.dbus_object_path,
3485
client.name)
3486
3487
mandos_dbus_service = MandosDBusService()
3488
3489
# Save modules to variables to exempt the modules from being
3490
# unloaded before the function registered with atexit() is run.
3491
mp = multiprocessing
3492
wn = wnull
3493
2380
2381
class MandosDBusServiceTransitional(MandosDBusService):
2382
__metaclass__ = AlternateDBusNamesMetaclass
2383
mandos_dbus_service = MandosDBusServiceTransitional()
2384
3494
2385
def cleanup():
3495
2386
"Cleanup function; run on exit"
3496
if zeroconf:
3497
service.cleanup()
3498
3499
mp.active_children()
3500
wn.close()
2387
service.cleanup()
2388
2389
multiprocessing.active_children()
3501
2390
if not (tcp_server.clients or client_settings):
3502
2391
return
3503
2392
3504
2393
# Store client before exiting. Secrets are encrypted with key
3505
2394
# based on what config file has. If config file is
3506
2395
# removed/edited, old secret will thus be unrecovable.
3507
clients = {}
3508
with PGPEngine() as pgp:
3509
for client in tcp_server.clients.values():
2396
clients = []
2397
with Crypto() as crypt:
2398
for client in tcp_server.clients.itervalues():
3510
2399
key = client_settings[client.name]["secret"]
3511
client.encrypted_secret = pgp.encrypt(client.secret,
3512
key)
2400
client.encrypted_secret = crypt.encrypt(client.secret,
2401
key)
3513
2402
client_dict = {}
3514
3515
# A list of attributes that can not be pickled
3516
# + secret.
3517
exclude = {"bus", "changedstate", "secret",
3518
"checker", "server_settings"}
3519
for name, typ in inspect.getmembers(dbus.service
3520
.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)):
3521
2409
exclude.add(name)
3522
2410
3523
2411
client_dict["encrypted_secret"] = (client
3524
2412
.encrypted_secret)
3525
2413
for attr in client.client_structure:
3526
2414
if attr not in exclude:
3527
2415
client_dict[attr] = getattr(client, attr)
3528
3529
clients[client.name] = client_dict
2416
2417
clients.append(client_dict)
3530
2418
del client_settings[client.name]["secret"]
3531
2419
3532
2420
try:
3533
with tempfile.NamedTemporaryFile(
3534
mode='wb',
3535
suffix=".pickle",
3536
prefix='clients-',
3537
dir=os.path.dirname(stored_state_path),
3538
delete=False) as stored_state:
3539
pickle.dump((clients, client_settings), stored_state,
3540
protocol=2)
3541
tempname = stored_state.name
3542
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)
3543
2425
except (IOError, OSError) as e:
3544
if not debug:
3545
try:
3546
os.remove(tempname)
3547
except NameError:
3548
pass
3549
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3550
logger.warning("Could not save persistent state: {}"
3551
.format(os.strerror(e.errno)))
3552
else:
3553
logger.warning("Could not save persistent state:",
3554
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):
3555
2429
raise
3556
2430
3557
2431
# Delete all clients, and settings from config
3558
2432
while tcp_server.clients:
3559
2433
name, client = tcp_server.clients.popitem()
3560
2434
if use_dbus:
3561
2435
client.remove_from_connection()
3562
# Don't signal the disabling
2436
# Don't signal anything except ClientRemoved
3563
2437
client.disable(quiet=True)
3564
# Emit D-Bus signal for removal
3565
2438
if use_dbus:
3566
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)
3567
2443
client_settings.clear()
3568
2444
3569
2445
atexit.register(cleanup)
3570
3571
for client in tcp_server.clients.values():
2446
2447
for client in tcp_server.clients.itervalues():
3572
2448
if use_dbus:
3573
# Emit D-Bus signal for adding
3574
mandos_dbus_service.client_added_signal(client)
2449
# Emit D-Bus signal
2450
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3575
2451
# Need to initiate checking of clients
3576
2452
if client.enabled:
3577
2453
client.init_checker()
3578
2454
3579
2455
tcp_server.enable()
3580
2456
tcp_server.server_activate()
3581
2457
3582
2458
# Find out what port we got
3583
if zeroconf:
3584
service.port = tcp_server.socket.getsockname()[1]
2459
service.port = tcp_server.socket.getsockname()[1]
3585
2460
if use_ipv6:
3586
2461
logger.info("Now listening on address %r, port %d,"
3587
" flowinfo %d, scope_id %d",
3588
*tcp_server.socket.getsockname())
2462
" flowinfo %d, scope_id %d"
2463
% tcp_server.socket.getsockname())
3589
2464
else: # IPv4
3590
logger.info("Now listening on address %r, port %d",
3591
*tcp_server.socket.getsockname())
3592
3593
# service.interface = tcp_server.socket.getsockname()[3]
3594
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
3595
2470
try:
3596
if zeroconf:
3597
# From the Avahi example code
3598
try:
3599
service.activate()
3600
except dbus.exceptions.DBusException as error:
3601
logger.critical("D-Bus Exception", exc_info=error)
3602
cleanup()
3603
sys.exit(1)
3604
# End of Avahi example code
3605
3606
GLib.io_add_watch(
3607
GLib.IOChannel.unix_new(tcp_server.fileno()),
3608
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3609
lambda *args, **kwargs: (tcp_server.handle_request
3610
(*args[2:], **kwargs) or True))
3611
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
3612
2485
logger.debug("Starting main loop")
3613
2486
main_loop.run()
3614
2487
except AvahiError as error:
3615
logger.critical("Avahi Error", exc_info=error)
2488
logger.critical("AvahiError: %s", error)
3616
2489
cleanup()
3617
2490
sys.exit(1)
3618
2491
except KeyboardInterrupt:
3623
2496
# Must run before the D-Bus bus name gets deregistered
3624
2497
cleanup()
3625
2498
3626
3627
def should_only_run_tests():
3628
parser = argparse.ArgumentParser(add_help=False)
3629
parser.add_argument("--check", action='store_true')
3630
args, unknown_args = parser.parse_known_args()
3631
run_tests = args.check
3632
if run_tests:
3633
# Remove --check argument from sys.argv
3634
sys.argv[1:] = unknown_args
3635
return run_tests
3636
3637
# Add all tests from doctest strings
3638
def load_tests(loader, tests, none):
3639
import doctest
3640
tests.addTests(doctest.DocTestSuite())
3641
return tests
3642
2499
3643
2500
if __name__ == '__main__':
3644
try:
3645
if should_only_run_tests():
3646
# Call using ./mandos --check [--verbose]
3647
unittest.main()
3648
else:
3649
main()
3650
finally:
3651
logging.shutdown()
2501
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0