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 1169
- compare with another revision
- download diff
- download tarball
- view history from revision 1169
- Committer: Teddy Hogeborn
- Date: 2019-08-24 15:33:58 UTC
- Revision ID: teddy@recompile.se-20190824153358-o69zprg8yiub1t0d
mandos-monitor: Use new GLib.io_add_watch() call signature
* mandos-monitor: When calling GLib.io_add_watch(), always pass a
channel as the first argument instead of a file
descriptor, and pass priority as the second
argument. This is supported by PyGObject 3.8 or
later.
* mandos-monitor: When calling GLib.io_add_watch(), always pass a
channel as the first argument instead of a file
descriptor, and pass priority as the second
argument. This is supported by PyGObject 3.8 or
later.
- files added:
- DBUS-API
- debian/source
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- files modified:
- .bzrignore
added
removed
mandos
1
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8 -*-
3
#
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
#
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,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 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
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
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
21
23
#
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
27
# GNU General Public License for more details.
26
#
28
#
27
29
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
#
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
#
33
34
from __future__ import division, with_statement, absolute_import
35
36
import SocketServer as socketserver
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
31
#
32
# Contact the authors at <mandos@recompile.se>.
33
#
34
35
from __future__ import (division, absolute_import, print_function,
36
unicode_literals)
37
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
47
import socket
38
import optparse
48
import argparse
39
49
import datetime
40
50
import errno
41
import gnutls.crypto
42
import gnutls.connection
43
import gnutls.errors
44
import gnutls.library.functions
45
import gnutls.library.constants
46
import gnutls.library.types
47
import ConfigParser as configparser
51
try:
52
import ConfigParser as configparser
53
except ImportError:
54
import configparser
48
55
import sys
49
56
import re
50
57
import os
59
66
import struct
60
67
import fcntl
61
68
import functools
62
import cPickle as pickle
69
try:
70
import cPickle as pickle
71
except ImportError:
72
import pickle
73
import multiprocessing
74
import types
75
import binascii
76
import tempfile
77
import itertools
78
import collections
79
import codecs
80
import unittest
63
81
64
82
import dbus
65
83
import dbus.service
66
import gobject
67
import avahi
84
import gi
85
from gi.repository import GLib
68
86
from dbus.mainloop.glib import DBusGMainLoop
69
87
import ctypes
70
88
import ctypes.util
71
89
import xml.dom.minidom
72
90
import inspect
73
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:
74
101
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:
75
104
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
76
105
except AttributeError:
77
106
try:
107
# This is where SO_BINDTODEVICE was up to and including Python
108
# 2.6, and also 3.2:
78
109
from IN import SO_BINDTODEVICE
79
110
except ImportError:
80
SO_BINDTODEVICE = None
81
82
83
version = "1.0.14"
84
85
logger = logging.Logger(u'mandos')
86
syslogger = (logging.handlers.SysLogHandler
87
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
88
address = "/dev/log"))
89
syslogger.setFormatter(logging.Formatter
90
(u'Mandos [%(process)d]: %(levelname)s:'
91
u' %(message)s'))
92
logger.addHandler(syslogger)
93
94
console = logging.StreamHandler()
95
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
96
u' %(levelname)s:'
97
u' %(message)s'))
98
logger.addHandler(console)
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"
132
stored_state_file = "clients.pickle"
133
134
logger = logging.getLogger()
135
logging.captureWarnings(True) # Show warnings via the logging system
136
syslogger = None
137
138
try:
139
if_nametoindex = ctypes.cdll.LoadLibrary(
140
ctypes.util.find_library("c")).if_nametoindex
141
except (OSError, AttributeError):
142
143
def if_nametoindex(interface):
144
"Get an interface index the hard way, i.e. using fcntl()"
145
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
146
with contextlib.closing(socket.socket()) as s:
147
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
148
struct.pack(b"16s16x", interface))
149
interface_index = struct.unpack("I", ifreq[16:20])[0]
150
return interface_index
151
152
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):
170
"""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"))
176
syslogger.setFormatter(logging.Formatter
177
('Mandos [%(process)d]: %(levelname)s:'
178
' %(message)s'))
179
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)
188
logger.setLevel(level)
189
190
191
class PGPError(Exception):
192
"""Exception if encryption/decryption fails"""
193
pass
194
195
196
class PGPEngine:
197
"""A simple class for OpenPGP symmetric encryption & decryption"""
198
199
def __init__(self):
200
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
220
def __enter__(self):
221
return self
222
223
def __exit__(self, exc_type, exc_value, traceback):
224
self._cleanup()
225
return False
226
227
def __del__(self):
228
self._cleanup()
229
230
def _cleanup(self):
231
if self.tempdir is not None:
232
# Delete contents of tempdir
233
for root, dirs, files in os.walk(self.tempdir,
234
topdown=False):
235
for filename in files:
236
os.remove(os.path.join(root, filename))
237
for dirname in dirs:
238
os.rmdir(os.path.join(root, dirname))
239
# Remove tempdir
240
os.rmdir(self.tempdir)
241
self.tempdir = None
242
243
def password_encode(self, password):
244
# Passphrase can not be empty and can not contain newlines or
245
# 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
254
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)
270
return ciphertext
271
272
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)
288
return decrypted_plaintext
289
290
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
99
316
100
317
class AvahiError(Exception):
101
318
def __init__(self, value, *args, **kwargs):
102
319
self.value = value
103
super(AvahiError, self).__init__(value, *args, **kwargs)
104
def __unicode__(self):
105
return unicode(repr(self.value))
320
return super(AvahiError, self).__init__(value, *args,
321
**kwargs)
322
106
323
107
324
class AvahiServiceError(AvahiError):
108
325
pass
109
326
327
110
328
class AvahiGroupError(AvahiError):
111
329
pass
112
330
113
331
114
class AvahiService(object):
332
class AvahiService:
115
333
"""An Avahi (Zeroconf) service.
116
334
117
335
Attributes:
118
336
interface: integer; avahi.IF_UNSPEC or an interface index.
119
337
Used to optionally bind to the specified interface.
120
name: string; Example: u'Mandos'
121
type: string; Example: u'_mandos._tcp'.
122
See <http://www.dns-sd.org/ServiceTypes.html>
338
name: string; Example: 'Mandos'
339
type: string; Example: '_mandos._tcp'.
340
See <https://www.iana.org/assignments/service-names-port-numbers>
123
341
port: integer; what port to announce
124
342
TXT: list of strings; TXT record for the service
125
343
domain: string; Domain to publish on, default to .local if empty.
131
349
server: D-Bus Server
132
350
bus: dbus.SystemBus()
133
351
"""
134
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
135
servicetype = None, port = None, TXT = None,
136
domain = u"", host = u"", max_renames = 32768,
137
protocol = avahi.PROTO_UNSPEC, bus = None):
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):
138
364
self.interface = interface
139
365
self.name = name
140
366
self.type = servicetype
148
374
self.group = None # our entry group
149
375
self.server = None
150
376
self.bus = bus
151
def rename(self):
377
self.entry_group_state_changed_match = None
378
379
def rename(self, remove=True):
152
380
"""Derived from the Avahi example code"""
153
381
if self.rename_count >= self.max_renames:
154
logger.critical(u"No suitable Zeroconf service name found"
155
u" after %i retries, exiting.",
382
logger.critical("No suitable Zeroconf service name found"
383
" after %i retries, exiting.",
156
384
self.rename_count)
157
raise AvahiServiceError(u"Too many renames")
158
self.name = self.server.GetAlternativeServiceName(self.name)
159
logger.info(u"Changing Zeroconf service name to %r ...",
160
unicode(self.name))
161
syslogger.setFormatter(logging.Formatter
162
(u'Mandos (%s) [%%(process)d]:'
163
u' %%(levelname)s: %%(message)s'
164
% self.name))
165
self.remove()
166
self.add()
385
raise AvahiServiceError("Too many renames")
386
self.name = str(
387
self.server.GetAlternativeServiceName(self.name))
167
388
self.rename_count += 1
389
logger.info("Changing Zeroconf service name to %r ...",
390
self.name)
391
if remove:
392
self.remove()
393
try:
394
self.add()
395
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
168
405
def remove(self):
169
406
"""Derived from the Avahi example code"""
407
if self.entry_group_state_changed_match is not None:
408
self.entry_group_state_changed_match.remove()
409
self.entry_group_state_changed_match = None
170
410
if self.group is not None:
171
411
self.group.Reset()
412
172
413
def add(self):
173
414
"""Derived from the Avahi example code"""
415
self.remove()
174
416
if self.group is None:
175
417
self.group = dbus.Interface(
176
418
self.bus.get_object(avahi.DBUS_NAME,
177
419
self.server.EntryGroupNew()),
178
420
avahi.DBUS_INTERFACE_ENTRY_GROUP)
179
self.group.connect_to_signal('StateChanged',
180
self
181
.entry_group_state_changed)
182
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
421
self.entry_group_state_changed_match = (
422
self.group.connect_to_signal(
423
'StateChanged', self.entry_group_state_changed))
424
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
183
425
self.name, self.type)
184
426
self.group.AddService(
185
427
self.interface,
190
432
dbus.UInt16(self.port),
191
433
avahi.string_array_to_txt_array(self.TXT))
192
434
self.group.Commit()
435
193
436
def entry_group_state_changed(self, state, error):
194
437
"""Derived from the Avahi example code"""
195
logger.debug(u"Avahi state change: %i", state)
196
438
logger.debug("Avahi entry group state change: %i", state)
439
197
440
if state == avahi.ENTRY_GROUP_ESTABLISHED:
198
logger.debug(u"Zeroconf service established.")
441
logger.debug("Zeroconf service established.")
199
442
elif state == avahi.ENTRY_GROUP_COLLISION:
200
logger.warning(u"Zeroconf service name collision.")
443
logger.info("Zeroconf service name collision.")
201
444
self.rename()
202
445
elif state == avahi.ENTRY_GROUP_FAILURE:
203
logger.critical(u"Avahi: Error in group state changed %s",
204
unicode(error))
205
raise AvahiGroupError(u"State changed: %s"
206
% unicode(error))
446
logger.critical("Avahi: Error in group state changed %s",
447
str(error))
448
raise AvahiGroupError("State changed: {!s}".format(error))
449
207
450
def cleanup(self):
208
451
"""Derived from the Avahi example code"""
209
452
if self.group is not None:
210
self.group.Free()
453
try:
454
self.group.Free()
455
except (dbus.exceptions.UnknownMethodException,
456
dbus.exceptions.DBusException):
457
pass
211
458
self.group = None
212
def server_state_changed(self, state):
459
self.remove()
460
461
def server_state_changed(self, state, error=None):
213
462
"""Derived from the Avahi example code"""
214
if state == avahi.SERVER_COLLISION:
215
logger.error(u"Zeroconf server name collision")
216
self.remove()
463
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
}
470
if state in bad_states:
471
if bad_states[state] is not None:
472
if error is None:
473
logger.error(bad_states[state])
474
else:
475
logger.error(bad_states[state] + ": %r", error)
476
self.cleanup()
217
477
elif state == avahi.SERVER_RUNNING:
218
self.add()
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)
490
else:
491
if error is None:
492
logger.debug("Unknown state: %r", state)
493
else:
494
logger.debug("Unknown state: %r: %r", state, error)
495
219
496
def activate(self):
220
497
"""Derived from the Avahi example code"""
221
498
if self.server is None:
222
499
self.server = dbus.Interface(
223
500
self.bus.get_object(avahi.DBUS_NAME,
224
avahi.DBUS_PATH_SERVER),
501
avahi.DBUS_PATH_SERVER,
502
follow_name_owner_changes=True),
225
503
avahi.DBUS_INTERFACE_SERVER)
226
self.server.connect_to_signal(u"StateChanged",
227
self.server_state_changed)
504
self.server.connect_to_signal("StateChanged",
505
self.server_state_changed)
228
506
self.server_state_changed(self.server.GetState())
229
507
230
508
231
class Client(object):
509
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
511
"""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)))
516
return ret
517
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:
232
832
"""A representation of a client host served by this server.
233
833
234
834
Attributes:
835
approved: bool(); 'None' if not yet approved/disapproved
836
approval_delay: datetime.timedelta(); Time to wait for approval
837
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
842
checker_command: string; External command which is run to check
843
if client lives. %() expansions are done at
844
runtime with vars(self) as dict, so that for
845
instance %(name)s can be used in the command.
846
checker_initiator_tag: a GLib event source tag, or None
847
created: datetime.datetime(); (UTC) object creation
848
client_structure: Object describing what attributes a client has
849
and is used for storing the client at exit
850
current_checker_command: string; current running checker_command
851
disable_initiator_tag: a GLib event source tag, or None
852
enabled: bool()
853
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
857
host: string; available for use by the checker command
858
interval: datetime.timedelta(); How often to start a new checker
859
last_approval_request: datetime.datetime(); (UTC) or None
860
last_checked_ok: datetime.datetime(); (UTC) or None
861
last_checker_status: integer between 0 and 255 reflecting exit
862
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
866
last_enabled: datetime.datetime(); (UTC) or None
235
867
name: string; from the config file, used in log messages and
236
868
D-Bus identifiers
237
fingerprint: string (40 or 32 hexadecimal digits); used to
238
uniquely identify the client
239
869
secret: bytestring; sent verbatim (over TLS) to client
240
host: string; available for use by the checker command
241
created: datetime.datetime(); (UTC) object creation
242
last_enabled: datetime.datetime(); (UTC)
243
enabled: bool()
244
last_checked_ok: datetime.datetime(); (UTC) or None
245
870
timeout: datetime.timedelta(); How long from last_checked_ok
246
871
until this client is disabled
247
interval: datetime.timedelta(); How often to start a new checker
248
disable_hook: If set, called by disable() as disable_hook(self)
249
checker: subprocess.Popen(); a running checker process used
250
to see if the client lives.
251
'None' if no process is running.
252
checker_initiator_tag: a gobject event source tag, or None
253
disable_initiator_tag: - '' -
254
checker_callback_tag: - '' -
255
checker_command: string; External command which is run to check if
256
client lives. %() expansions are done at
257
runtime with vars(self) as dict, so that for
258
instance %(name)s can be used in the command.
259
current_checker_command: string; current running checker_command
872
extended_timeout: extra long timeout when secret has been sent
873
runtime_expansions: Allowed attributes for runtime expansion.
874
expires: datetime.datetime(); time (UTC) when a client will be
875
disabled, or None
876
server_settings: The server_settings dict from main()
260
877
"""
261
878
879
runtime_expansions = ("approval_delay", "approval_duration",
880
"created", "enabled", "expires", "key_id",
881
"fingerprint", "host", "interval",
882
"last_approval_request", "last_checked_ok",
883
"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
262
896
@staticmethod
263
def _timedelta_to_milliseconds(td):
264
"Convert a datetime.timedelta() to milliseconds"
265
return ((td.days * 24 * 60 * 60 * 1000)
266
+ (td.seconds * 1000)
267
+ (td.microseconds // 1000))
268
269
def timeout_milliseconds(self):
270
"Return the 'timeout' attribute in milliseconds"
271
return self._timedelta_to_milliseconds(self.timeout)
272
273
def interval_milliseconds(self):
274
"Return the 'interval' attribute in milliseconds"
275
return self._timedelta_to_milliseconds(self.interval)
276
277
def __init__(self, name = None, disable_hook=None, config=None):
278
"""Note: the 'checker' key in 'config' sets the
279
'checker_command' attribute and *not* the 'checker'
280
attribute."""
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):
281
951
self.name = name
282
if config is None:
283
config = {}
284
logger.debug(u"Creating client %r", self.name)
285
# Uppercase and remove spaces from fingerprint for later
286
# comparison purposes with return value from the fingerprint()
287
# function
288
self.fingerprint = (config[u"fingerprint"].upper()
289
.replace(u" ", u""))
290
logger.debug(u" Fingerprint: %s", self.fingerprint)
291
if u"secret" in config:
292
self.secret = config[u"secret"].decode(u"base64")
293
elif u"secfile" in config:
294
with open(os.path.expanduser(os.path.expandvars
295
(config[u"secfile"])),
296
"rb") as secfile:
297
self.secret = secfile.read()
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)
298
965
else:
299
raise TypeError(u"No secret or secfile for client %s"
300
% self.name)
301
self.host = config.get(u"host", u"")
302
self.created = datetime.datetime.utcnow()
303
self.enabled = False
304
self.last_enabled = None
305
self.last_checked_ok = None
306
self.timeout = string_to_delta(config[u"timeout"])
307
self.interval = string_to_delta(config[u"interval"])
308
self.disable_hook = disable_hook
966
self.last_enabled = None
967
self.expires = None
968
969
logger.debug("Creating client %r", self.name)
970
logger.debug(" Key ID: %s", self.key_id)
971
logger.debug(" Fingerprint: %s", self.fingerprint)
972
self.created = settings.get("created",
973
datetime.datetime.utcnow())
974
975
# attributes specific for this server instance
309
976
self.checker = None
310
977
self.checker_initiator_tag = None
311
978
self.disable_initiator_tag = None
312
979
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
314
980
self.current_checker_command = None
315
self.last_connect = None
316
981
self.approved = None
982
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()
987
if not attr.startswith("_")]
988
self.client_structure.append("client_structure")
989
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
992
if not name.startswith("_"):
993
self.client_structure.append(name)
994
995
# Send notice to process children that client state has changed
996
def send_changedstate(self):
997
with self.changedstate:
998
self.changedstate.notify_all()
999
317
1000
def enable(self):
318
1001
"""Start this client's checker and timeout hooks"""
319
if getattr(self, u"enabled", False):
1002
if getattr(self, "enabled", False):
320
1003
# Already enabled
321
1004
return
1005
self.expires = datetime.datetime.utcnow() + self.timeout
1006
self.enabled = True
322
1007
self.last_enabled = datetime.datetime.utcnow()
1008
self.init_checker()
1009
self.send_changedstate()
1010
1011
def disable(self, quiet=True):
1012
"""Disable this client."""
1013
if not getattr(self, "enabled", False):
1014
return False
1015
if not quiet:
1016
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)
1019
self.disable_initiator_tag = None
1020
self.expires = None
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
1023
self.checker_initiator_tag = None
1024
self.stop_checker()
1025
self.enabled = False
1026
if not quiet:
1027
self.send_changedstate()
1028
# Do not run this again if called by a GLib.timeout_add
1029
return False
1030
1031
def __del__(self):
1032
self.disable()
1033
1034
def init_checker(self):
323
1035
# Schedule a new checker to be started an 'interval' from now,
324
1036
# and every interval from then on.
325
self.checker_initiator_tag = (gobject.timeout_add
326
(self.interval_milliseconds(),
327
self.start_checker))
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)
328
1042
# Schedule a disable() when 'timeout' has passed
329
self.disable_initiator_tag = (gobject.timeout_add
330
(self.timeout_milliseconds(),
331
self.disable))
332
self.enabled = True
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)
333
1047
# Also start a new checker *right now*.
334
1048
self.start_checker()
335
336
def disable(self, quiet=True):
337
"""Disable this client."""
338
if not getattr(self, "enabled", False):
339
return False
340
if not quiet:
341
logger.info(u"Disabling client %s", self.name)
342
if getattr(self, u"disable_initiator_tag", False):
343
gobject.source_remove(self.disable_initiator_tag)
344
self.disable_initiator_tag = None
345
if getattr(self, u"checker_initiator_tag", False):
346
gobject.source_remove(self.checker_initiator_tag)
347
self.checker_initiator_tag = None
348
self.stop_checker()
349
if self.disable_hook:
350
self.disable_hook(self)
351
self.enabled = False
352
# Do not run this again if called by a gobject.timeout_add
353
return False
354
355
def __del__(self):
356
self.disable_hook = None
357
self.disable()
358
359
def checker_callback(self, pid, condition, command):
1049
1050
def checker_callback(self, source, condition, connection,
1051
command):
360
1052
"""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()
361
1057
self.checker_callback_tag = None
362
1058
self.checker = None
363
if os.WIFEXITED(condition):
364
exitstatus = os.WEXITSTATUS(condition)
365
if exitstatus == 0:
366
logger.info(u"Checker for %(name)s succeeded",
1059
1060
if returncode >= 0:
1061
self.last_checker_status = returncode
1062
self.last_checker_signal = None
1063
if self.last_checker_status == 0:
1064
logger.info("Checker for %(name)s succeeded",
367
1065
vars(self))
368
1066
self.checked_ok()
369
1067
else:
370
logger.info(u"Checker for %(name)s failed",
371
vars(self))
1068
logger.info("Checker for %(name)s failed", vars(self))
372
1069
else:
373
logger.warning(u"Checker for %(name)s crashed?",
1070
self.last_checker_status = -1
1071
self.last_checker_signal = -returncode
1072
logger.warning("Checker for %(name)s crashed?",
374
1073
vars(self))
375
1074
return False
1075
376
1076
def checked_ok(self):
377
"""Bump up the timeout for this client.
378
379
This should only be called when the client has been seen,
380
alive and well.
381
"""
1077
"""Assert that the client has been seen, alive and well."""
382
1078
self.last_checked_ok = datetime.datetime.utcnow()
383
gobject.source_remove(self.disable_initiator_tag)
384
self.disable_initiator_tag = (gobject.timeout_add
385
(self.timeout_milliseconds(),
386
self.disable))
387
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."""
1085
if timeout is None:
1086
timeout = self.timeout
1087
if self.disable_initiator_tag is not None:
1088
GLib.source_remove(self.disable_initiator_tag)
1089
self.disable_initiator_tag = None
1090
if getattr(self, "enabled", False):
1091
self.disable_initiator_tag = GLib.timeout_add(
1092
int(timeout.total_seconds() * 1000), self.disable)
1093
self.expires = datetime.datetime.utcnow() + timeout
1094
1095
def need_approval(self):
1096
self.last_approval_request = datetime.datetime.utcnow()
1097
388
1098
def start_checker(self):
389
1099
"""Start a new checker subprocess if one is not running.
390
1100
391
1101
If a checker already exists, leave it running and do
392
1102
nothing."""
393
1103
# The reason for not killing a running checker is that if we
394
# did that, then if a checker (for some reason) started
395
# running slowly and taking more than 'interval' time, the
396
# client would inevitably timeout, since no checker would get
397
# a chance to run to completion. If we instead leave running
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
398
1108
# checkers alone, the checker would have to take more time
399
1109
# than 'timeout' for the client to be disabled, which is as it
400
1110
# should be.
401
402
# If a checker exists, make sure it is not a zombie
403
try:
404
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
405
except (AttributeError, OSError), error:
406
if (isinstance(error, OSError)
407
and error.errno != errno.ECHILD):
408
raise error
409
else:
410
if pid:
411
logger.warning(u"Checker was a zombie")
412
gobject.source_remove(self.checker_callback_tag)
413
self.checker_callback(pid, status,
414
self.current_checker_command)
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
415
1116
# Start a new checker if needed
416
1117
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}
417
1122
try:
418
# In case checker_command has exactly one % operator
419
command = self.checker_command % self.host
420
except TypeError:
421
# Escape attributes for the shell
422
escaped_attrs = dict((key,
423
re.escape(unicode(str(val),
424
errors=
425
u'replace')))
426
for key, val in
427
vars(self).iteritems())
428
try:
429
command = self.checker_command % escaped_attrs
430
except TypeError, error:
431
logger.error(u'Could not format string "%s":'
432
u' %s', self.checker_command, error)
433
return True # Try again later
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
434
1129
self.current_checker_command = command
435
try:
436
logger.info(u"Starting checker %r for %s",
437
command, self.name)
438
# We don't need to redirect stdout and stderr, since
439
# in normal mode, that is already done by daemon(),
440
# and in debug mode we don't want to. (Stdin is
441
# always replaced by /dev/null.)
442
self.checker = subprocess.Popen(command,
443
close_fds=True,
444
shell=True, cwd=u"/")
445
self.checker_callback_tag = (gobject.child_watch_add
446
(self.checker.pid,
447
self.checker_callback,
448
data=command))
449
# The checker may have completed before the gobject
450
# watch was added. Check for this.
451
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
452
if pid:
453
gobject.source_remove(self.checker_callback_tag)
454
self.checker_callback(pid, status, command)
455
except OSError, error:
456
logger.error(u"Failed to start subprocess: %s",
457
error)
458
# Re-run this periodically if run by gobject.timeout_add
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
459
1157
return True
460
1158
461
1159
def stop_checker(self):
462
1160
"""Force the checker process, if any, to stop."""
463
1161
if self.checker_callback_tag:
464
gobject.source_remove(self.checker_callback_tag)
1162
GLib.source_remove(self.checker_callback_tag)
465
1163
self.checker_callback_tag = None
466
if getattr(self, u"checker", None) is None:
1164
if getattr(self, "checker", None) is None:
467
1165
return
468
logger.debug(u"Stopping checker for %(name)s", vars(self))
469
try:
470
os.kill(self.checker.pid, signal.SIGTERM)
471
#time.sleep(0.5)
472
#if self.checker.poll() is None:
473
# os.kill(self.checker.pid, signal.SIGKILL)
474
except OSError, error:
475
if error.errno != errno.ESRCH: # No such process
476
raise
1166
logger.debug("Stopping checker for %(name)s", vars(self))
1167
self.checker.terminate()
477
1168
self.checker = None
478
1169
479
1170
480
def dbus_service_property(dbus_interface, signature=u"v",
481
access=u"readwrite", byte_arrays=False):
1171
def dbus_service_property(dbus_interface,
1172
signature="v",
1173
access="readwrite",
1174
byte_arrays=False):
482
1175
"""Decorators for marking methods of a DBusObjectWithProperties to
483
1176
become properties on the D-Bus.
484
1177
485
1178
The decorated method will be called with no arguments by "Get"
486
1179
and with one argument by "Set".
487
1180
488
1181
The parameters, where they are supported, are the same as
489
1182
dbus.service.method, except there is only "signature", since the
490
1183
type from Get() and the type sent to Set() is the same.
491
1184
"""
492
1185
# Encoding deeply encoded byte arrays is not supported yet by the
493
1186
# "Set" method, so we fail early here:
494
if byte_arrays and signature != u"ay":
495
raise ValueError(u"Byte arrays not supported for non-'ay'"
496
u" signature %r" % signature)
1187
if byte_arrays and signature != "ay":
1188
raise ValueError("Byte arrays not supported for non-'ay'"
1189
" signature {!r}".format(signature))
1190
497
1191
def decorator(func):
498
1192
func._dbus_is_property = True
499
1193
func._dbus_interface = dbus_interface
500
1194
func._dbus_signature = signature
501
1195
func._dbus_access = access
502
1196
func._dbus_name = func.__name__
503
if func._dbus_name.endswith(u"_dbus_property"):
1197
if func._dbus_name.endswith("_dbus_property"):
504
1198
func._dbus_name = func._dbus_name[:-14]
505
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
506
return func
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
507
1245
return decorator
508
1246
509
1247
510
1248
class DBusPropertyException(dbus.exceptions.DBusException):
511
1249
"""A base class for D-Bus property-related exceptions
512
1250
"""
513
def __unicode__(self):
514
return unicode(str(self))
1251
pass
515
1252
516
1253
517
1254
class DBusPropertyAccessException(DBusPropertyException):
526
1263
pass
527
1264
528
1265
529
class DBusObjectWithProperties(dbus.service.Object):
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):
530
1356
"""A D-Bus object with properties.
531
1357
532
1358
Classes inheriting from this can use the dbus_service_property
533
1359
decorator to expose methods as D-Bus properties. It exposes the
534
1360
standard Get(), Set(), and GetAll() methods on the D-Bus.
535
1361
"""
536
537
@staticmethod
538
def _is_dbus_property(obj):
539
return getattr(obj, u"_dbus_is_property", False)
540
541
def _get_all_dbus_properties(self):
542
"""Returns a generator of (name, attribute) pairs
543
"""
544
return ((prop._dbus_name, prop)
545
for name, prop in
546
inspect.getmembers(self, self._is_dbus_property))
547
1362
548
1363
def _get_dbus_property(self, interface_name, property_name):
549
1364
"""Returns a bound method if one exists which is a D-Bus
550
1365
property with the specified name and interface.
551
1366
"""
552
for name in (property_name,
553
property_name + u"_dbus_property"):
554
prop = getattr(self, name, None)
555
if (prop is None
556
or not self._is_dbus_property(prop)
557
or prop._dbus_name != property_name
558
or (interface_name and prop._dbus_interface
559
and interface_name != prop._dbus_interface)):
560
continue
561
return prop
1367
for cls in self.__class__.__mro__:
1368
for name, value in inspect.getmembers(
1369
cls, self._is_dbus_thing("property")):
1370
if (value._dbus_name == property_name
1371
and value._dbus_interface == interface_name):
1372
return value.__get__(self)
1373
562
1374
# No such property
563
raise DBusPropertyNotFound(self.dbus_object_path + u":"
564
+ interface_name + u"."
565
+ property_name)
566
567
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
568
out_signature=u"v")
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",
1389
out_signature="v")
569
1390
def Get(self, interface_name, property_name):
570
1391
"""Standard D-Bus property Get() method, see D-Bus standard.
571
1392
"""
572
1393
prop = self._get_dbus_property(interface_name, property_name)
573
if prop._dbus_access == u"write":
1394
if prop._dbus_access == "write":
574
1395
raise DBusPropertyAccessException(property_name)
575
1396
value = prop()
576
if not hasattr(value, u"variant_level"):
1397
if not hasattr(value, "variant_level"):
577
1398
return value
578
1399
return type(value)(value, variant_level=value.variant_level+1)
579
580
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1400
1401
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
581
1402
def Set(self, interface_name, property_name, value):
582
1403
"""Standard D-Bus property Set() method, see D-Bus standard.
583
1404
"""
584
1405
prop = self._get_dbus_property(interface_name, property_name)
585
if prop._dbus_access == u"read":
1406
if prop._dbus_access == "read":
586
1407
raise DBusPropertyAccessException(property_name)
587
if prop._dbus_get_args_options[u"byte_arrays"]:
1408
if prop._dbus_get_args_options["byte_arrays"]:
588
1409
# The byte_arrays option is not supported yet on
589
1410
# signatures other than "ay".
590
if prop._dbus_signature != u"ay":
591
raise ValueError
592
value = dbus.ByteArray(''.join(unichr(byte)
593
for byte in value))
1411
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))
594
1417
prop(value)
595
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
597
out_signature=u"a{sv}")
1418
1419
@dbus.service.method(dbus.PROPERTIES_IFACE,
1420
in_signature="s",
1421
out_signature="a{sv}")
598
1422
def GetAll(self, interface_name):
599
1423
"""Standard D-Bus property GetAll() method, see D-Bus
600
1424
standard.
601
1425
602
1426
Note: Will not include properties with access="write".
603
1427
"""
604
all = {}
605
for name, prop in self._get_all_dbus_properties():
1428
properties = {}
1429
for name, prop in self._get_all_dbus_things("property"):
606
1430
if (interface_name
607
1431
and interface_name != prop._dbus_interface):
608
1432
# Interface non-empty but did not match
609
1433
continue
610
1434
# Ignore write-only properties
611
if prop._dbus_access == u"write":
1435
if prop._dbus_access == "write":
612
1436
continue
613
1437
value = prop()
614
if not hasattr(value, u"variant_level"):
615
all[name] = value
1438
if not hasattr(value, "variant_level"):
1439
properties[name] = value
616
1440
continue
617
all[name] = type(value)(value, variant_level=
618
value.variant_level+1)
619
return dbus.Dictionary(all, signature=u"sv")
620
1441
properties[name] = type(value)(
1442
value, variant_level=value.variant_level + 1)
1443
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
621
1453
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
622
out_signature=u"s",
1454
out_signature="s",
623
1455
path_keyword='object_path',
624
1456
connection_keyword='connection')
625
1457
def Introspect(self, object_path, connection):
626
"""Standard D-Bus method, overloaded to insert property tags.
1458
"""Overloading of standard D-Bus method.
1459
1460
Inserts property tags and interface annotation tags.
627
1461
"""
628
xmlstring = dbus.service.Object.Introspect(self, object_path,
629
connection)
1462
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1463
object_path,
1464
connection)
630
1465
try:
631
1466
document = xml.dom.minidom.parseString(xmlstring)
1467
632
1468
def make_tag(document, name, prop):
633
e = document.createElement(u"property")
634
e.setAttribute(u"name", name)
635
e.setAttribute(u"type", prop._dbus_signature)
636
e.setAttribute(u"access", prop._dbus_access)
1469
e = document.createElement("property")
1470
e.setAttribute("name", name)
1471
e.setAttribute("type", prop._dbus_signature)
1472
e.setAttribute("access", prop._dbus_access)
637
1473
return e
638
for if_tag in document.getElementsByTagName(u"interface"):
1474
1475
for if_tag in document.getElementsByTagName("interface"):
1476
# Add property tags
639
1477
for tag in (make_tag(document, name, prop)
640
1478
for name, prop
641
in self._get_all_dbus_properties()
1479
in self._get_all_dbus_things("property")
642
1480
if prop._dbus_interface
643
== if_tag.getAttribute(u"name")):
1481
== if_tag.getAttribute("name")):
644
1482
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)
645
1499
# Add the names to the return values for the
646
1500
# "org.freedesktop.DBus.Properties" methods
647
if (if_tag.getAttribute(u"name")
648
== u"org.freedesktop.DBus.Properties"):
649
for cn in if_tag.getElementsByTagName(u"method"):
650
if cn.getAttribute(u"name") == u"Get":
651
for arg in cn.getElementsByTagName(u"arg"):
652
if (arg.getAttribute(u"direction")
653
== u"out"):
654
arg.setAttribute(u"name", u"value")
655
elif cn.getAttribute(u"name") == u"GetAll":
656
for arg in cn.getElementsByTagName(u"arg"):
657
if (arg.getAttribute(u"direction")
658
== u"out"):
659
arg.setAttribute(u"name", u"props")
660
xmlstring = document.toxml(u"utf-8")
661
document.unlink()
662
except (AttributeError, xml.dom.DOMException,
663
xml.parsers.expat.ExpatError), error:
664
logger.error(u"Failed to override Introspection method",
665
error)
666
return xmlstring
667
668
1501
if (if_tag.getAttribute("name")
1502
== "org.freedesktop.DBus.Properties"):
1503
for cn in if_tag.getElementsByTagName("method"):
1504
if cn.getAttribute("name") == "Get":
1505
for arg in cn.getElementsByTagName("arg"):
1506
if (arg.getAttribute("direction")
1507
== "out"):
1508
arg.setAttribute("name", "value")
1509
elif cn.getAttribute("name") == "GetAll":
1510
for arg in cn.getElementsByTagName("arg"):
1511
if (arg.getAttribute("direction")
1512
== "out"):
1513
arg.setAttribute("name", "props")
1514
xmlstring = document.toxml("utf-8")
1515
document.unlink()
1516
except (AttributeError, xml.dom.DOMException,
1517
xml.parsers.expat.ExpatError) as error:
1518
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):
1595
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1596
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).
1623
"""
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):
1632
# Ignore non-D-Bus attributes, and D-Bus attributes
1633
# with the wrong interface name
1634
if (not hasattr(attribute, "_dbus_interface")
1635
or not attribute._dbus_interface.startswith(
1636
orig_interface_name)):
1637
continue
1638
# Create an alternate D-Bus interface name based on
1639
# the current name
1640
alt_interface = attribute._dbus_interface.replace(
1641
orig_interface_name, alt_interface_name)
1642
interface_names.add(alt_interface)
1643
# Is this a D-Bus signal?
1644
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(
1649
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)
1657
# Create a new, but exactly alike, function
1658
# object, and decorate it to be a new D-Bus signal
1659
# 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
1671
# 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
1675
def fixscope(func1, func2):
1676
"""This function is a scope container to pass
1677
func1 and func2 to the "call_both" function
1678
outside of its arguments"""
1679
1680
@functools.wraps(func2)
1681
def call_both(*args, **kwargs):
1682
"""This function will emit two D-Bus
1683
signals by calling func1 and func2"""
1684
func1(*args, **kwargs)
1685
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
return call_both
1693
# Create the "call_both" function and add it to
1694
# the class
1695
attr[attrname] = fixscope(attribute, new_function)
1696
# Is this a D-Bus method?
1697
elif getattr(attribute, "_dbus_is_method", False):
1698
# Create a new, but exactly alike, function
1699
# object. Decorate it to be a new D-Bus method
1700
# with the alternate D-Bus interface name. Add it
1701
# 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
1714
# Is this a D-Bus property?
1715
elif getattr(attribute, "_dbus_is_property", False):
1716
# Create a new, but exactly alike, function
1717
# object, and decorate it to be a new D-Bus
1718
# property with the alternate D-Bus interface
1719
# 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"})
669
1772
class ClientDBus(Client, DBusObjectWithProperties):
670
1773
"""A Client class using D-Bus
671
1774
672
1775
Attributes:
673
1776
dbus_object_path: dbus.ObjectPath
674
1777
bus: dbus.SystemBus()
675
1778
"""
1779
1780
runtime_expansions = (Client.runtime_expansions
1781
+ ("dbus_object_path", ))
1782
1783
_interface = "se.recompile.Mandos.Client"
1784
676
1785
# dbus.service.Object doesn't use super(), so we can't either.
677
678
def __init__(self, bus = None, *args, **kwargs):
1786
1787
def __init__(self, bus=None, *args, **kwargs):
679
1788
self.bus = bus
680
1789
Client.__init__(self, *args, **kwargs)
681
1790
# Only now, when this client is initialized, can it show up on
682
1791
# the D-Bus
683
self.dbus_object_path = (dbus.ObjectPath
684
(u"/clients/"
685
+ self.name.replace(u".", u"_")))
1792
client_object_name = str(self.name).translate(
1793
{ord("."): ord("_"),
1794
ord("-"): ord("_")})
1795
self.dbus_object_path = dbus.ObjectPath(
1796
"/clients/" + client_object_name)
686
1797
DBusObjectWithProperties.__init__(self, self.bus,
687
1798
self.dbus_object_path)
688
689
@staticmethod
690
def _datetime_to_dbus(dt, variant_level=0):
691
"""Convert a UTC datetime.datetime() to a D-Bus type."""
692
return dbus.String(dt.isoformat(),
693
variant_level=variant_level)
694
695
def enable(self):
696
oldstate = getattr(self, u"enabled", False)
697
r = Client.enable(self)
698
if oldstate != self.enabled:
699
# Emit D-Bus signals
700
self.PropertyChanged(dbus.String(u"enabled"),
701
dbus.Boolean(True, variant_level=1))
702
self.PropertyChanged(
703
dbus.String(u"last_enabled"),
704
self._datetime_to_dbus(self.last_enabled,
705
variant_level=1))
706
return r
707
708
def disable(self, quiet = False):
709
oldstate = getattr(self, u"enabled", False)
710
r = Client.disable(self, quiet=quiet)
711
if not quiet and oldstate != self.enabled:
712
# Emit D-Bus signal
713
self.PropertyChanged(dbus.String(u"enabled"),
714
dbus.Boolean(False, variant_level=1))
715
return r
716
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):
1805
""" Modify a variable so that it's a property which announces
1806
its changes to DBus.
1807
1808
transform_fun: Function that takes a value and a variant_level
1809
and transforms it to a D-Bus type.
1810
dbus_name: D-Bus name of the variable
1811
type_func: Function that transform the value before sending it
1812
to the D-Bus. Default: no transform
1813
variant_level: D-Bus variant level. Default: 1
1814
"""
1815
attrname = "_{}".format(dbus_name)
1816
1817
def setter(self, value):
1818
if hasattr(self, "dbus_object_path"):
1819
if (not hasattr(self, attrname) or
1820
type_func(getattr(self, attrname, None))
1821
!= 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())
1837
setattr(self, attrname, value)
1838
1839
return property(lambda self: getattr(self, attrname), setter)
1840
1841
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1842
approvals_pending = notifychangeproperty(dbus.Boolean,
1843
"ApprovalPending",
1844
type_func=bool)
1845
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1846
last_enabled = notifychangeproperty(datetime_to_dbus,
1847
"LastEnabled")
1848
checker = notifychangeproperty(
1849
dbus.Boolean, "CheckerRunning",
1850
type_func=lambda checker: checker is not None)
1851
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1852
"LastCheckedOK")
1853
last_checker_status = notifychangeproperty(dbus.Int16,
1854
"LastCheckerStatus")
1855
last_approval_request = notifychangeproperty(
1856
datetime_to_dbus, "LastApprovalRequest")
1857
approved_by_default = notifychangeproperty(dbus.Boolean,
1858
"ApprovedByDefault")
1859
approval_delay = notifychangeproperty(
1860
dbus.UInt64, "ApprovalDelay",
1861
type_func=lambda td: td.total_seconds() * 1000)
1862
approval_duration = notifychangeproperty(
1863
dbus.UInt64, "ApprovalDuration",
1864
type_func=lambda td: td.total_seconds() * 1000)
1865
host = notifychangeproperty(dbus.String, "Host")
1866
timeout = notifychangeproperty(
1867
dbus.UInt64, "Timeout",
1868
type_func=lambda td: td.total_seconds() * 1000)
1869
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)
1875
checker_command = notifychangeproperty(dbus.String, "Checker")
1876
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1877
invalidate_only=True)
1878
1879
del notifychangeproperty
1880
717
1881
def __del__(self, *args, **kwargs):
718
1882
try:
719
1883
self.remove_from_connection()
720
1884
except LookupError:
721
1885
pass
722
if hasattr(DBusObjectWithProperties, u"__del__"):
1886
if hasattr(DBusObjectWithProperties, "__del__"):
723
1887
DBusObjectWithProperties.__del__(self, *args, **kwargs)
724
1888
Client.__del__(self, *args, **kwargs)
725
726
def checker_callback(self, pid, condition, command,
727
*args, **kwargs):
728
self.checker_callback_tag = None
729
self.checker = None
730
# Emit D-Bus signal
731
self.PropertyChanged(dbus.String(u"checker_running"),
732
dbus.Boolean(False, variant_level=1))
733
if os.WIFEXITED(condition):
734
exitstatus = os.WEXITSTATUS(condition)
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:
735
1897
# Emit D-Bus signal
736
1898
self.CheckerCompleted(dbus.Int16(exitstatus),
737
dbus.Int64(condition),
1899
# This is specific to GNU libC
1900
dbus.Int64(exitstatus << 8),
738
1901
dbus.String(command))
739
1902
else:
740
1903
# Emit D-Bus signal
741
1904
self.CheckerCompleted(dbus.Int16(-1),
742
dbus.Int64(condition),
1905
dbus.Int64(
1906
# This is specific to GNU libC
1907
(exitstatus << 8)
1908
| self.last_checker_signal),
743
1909
dbus.String(command))
744
745
return Client.checker_callback(self, pid, condition, command,
746
*args, **kwargs)
747
748
def checked_ok(self, *args, **kwargs):
749
r = Client.checked_ok(self, *args, **kwargs)
750
# Emit D-Bus signal
751
self.PropertyChanged(
752
dbus.String(u"last_checked_ok"),
753
(self._datetime_to_dbus(self.last_checked_ok,
754
variant_level=1)))
755
return r
756
1910
return ret
1911
757
1912
def start_checker(self, *args, **kwargs):
758
old_checker = self.checker
759
if self.checker is not None:
760
old_checker_pid = self.checker.pid
761
else:
762
old_checker_pid = None
1913
old_checker_pid = getattr(self.checker, "pid", None)
763
1914
r = Client.start_checker(self, *args, **kwargs)
764
1915
# Only if new checker process was started
765
1916
if (self.checker is not None
766
1917
and old_checker_pid != self.checker.pid):
767
1918
# Emit D-Bus signal
768
1919
self.CheckerStarted(self.current_checker_command)
769
self.PropertyChanged(
770
dbus.String(u"checker_running"),
771
dbus.Boolean(True, variant_level=1))
772
return r
773
774
def stop_checker(self, *args, **kwargs):
775
old_checker = getattr(self, u"checker", None)
776
r = Client.stop_checker(self, *args, **kwargs)
777
if (old_checker is not None
778
and getattr(self, u"checker", None) is None):
779
self.PropertyChanged(dbus.String(u"checker_running"),
780
dbus.Boolean(False, variant_level=1))
781
return r
782
783
## D-Bus methods & signals
784
_interface = u"se.bsnet.fukt.Mandos.Client"
785
786
# CheckedOK - method
787
@dbus.service.method(_interface)
788
def CheckedOK(self):
789
return self.checked_ok()
790
1920
return r
1921
1922
def _reset_approved(self):
1923
self.approved = None
1924
return False
1925
1926
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
self.send_changedstate()
1931
1932
# D-Bus methods, signals & properties
1933
1934
# Interfaces
1935
1936
# Signals
1937
791
1938
# CheckerCompleted - signal
792
@dbus.service.signal(_interface, signature=u"nxs")
1939
@dbus.service.signal(_interface, signature="nxs")
793
1940
def CheckerCompleted(self, exitcode, waitstatus, command):
794
1941
"D-Bus signal"
795
1942
pass
796
1943
797
1944
# CheckerStarted - signal
798
@dbus.service.signal(_interface, signature=u"s")
1945
@dbus.service.signal(_interface, signature="s")
799
1946
def CheckerStarted(self, command):
800
1947
"D-Bus signal"
801
1948
pass
802
1949
803
1950
# PropertyChanged - signal
804
@dbus.service.signal(_interface, signature=u"sv")
1951
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1952
@dbus.service.signal(_interface, signature="sv")
805
1953
def PropertyChanged(self, property, value):
806
1954
"D-Bus signal"
807
1955
pass
808
1956
809
1957
# GotSecret - signal
810
1958
@dbus.service.signal(_interface)
811
1959
def GotSecret(self):
812
"D-Bus signal"
1960
"""D-Bus signal
1961
Is sent after a successful transfer of secret from the Mandos
1962
server to mandos-client
1963
"""
813
1964
pass
814
1965
815
1966
# Rejected - signal
816
@dbus.service.signal(_interface)
817
def Rejected(self):
1967
@dbus.service.signal(_interface, signature="s")
1968
def Rejected(self, reason):
818
1969
"D-Bus signal"
819
1970
pass
820
1971
1972
# NeedApproval - signal
1973
@dbus.service.signal(_interface, signature="tb")
1974
def NeedApproval(self, timeout, default):
1975
"D-Bus signal"
1976
return self.need_approval()
1977
1978
# Methods
1979
1980
# Approve - method
1981
@dbus.service.method(_interface, in_signature="b")
1982
def Approve(self, value):
1983
self.approve(value)
1984
1985
# CheckedOK - method
1986
@dbus.service.method(_interface)
1987
def CheckedOK(self):
1988
self.checked_ok()
1989
821
1990
# Enable - method
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
822
1992
@dbus.service.method(_interface)
823
1993
def Enable(self):
824
1994
"D-Bus method"
825
1995
self.enable()
826
1996
827
1997
# StartChecker - method
1998
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
828
1999
@dbus.service.method(_interface)
829
2000
def StartChecker(self):
830
2001
"D-Bus method"
831
2002
self.start_checker()
832
2003
833
2004
# Disable - method
2005
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
834
2006
@dbus.service.method(_interface)
835
2007
def Disable(self):
836
2008
"D-Bus method"
837
2009
self.disable()
838
2010
839
2011
# StopChecker - method
2012
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
840
2013
@dbus.service.method(_interface)
841
2014
def StopChecker(self):
842
2015
self.stop_checker()
843
844
# name - property
845
@dbus_service_property(_interface, signature=u"s", access=u"read")
846
def name_dbus_property(self):
2016
2017
# Properties
2018
2019
# ApprovalPending - property
2020
@dbus_service_property(_interface, signature="b", access="read")
2021
def ApprovalPending_dbus_property(self):
2022
return dbus.Boolean(bool(self.approvals_pending))
2023
2024
# ApprovedByDefault - property
2025
@dbus_service_property(_interface,
2026
signature="b",
2027
access="readwrite")
2028
def ApprovedByDefault_dbus_property(self, value=None):
2029
if value is None: # get
2030
return dbus.Boolean(self.approved_by_default)
2031
self.approved_by_default = bool(value)
2032
2033
# ApprovalDelay - property
2034
@dbus_service_property(_interface,
2035
signature="t",
2036
access="readwrite")
2037
def ApprovalDelay_dbus_property(self, value=None):
2038
if value is None: # get
2039
return dbus.UInt64(self.approval_delay.total_seconds()
2040
* 1000)
2041
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2042
2043
# ApprovalDuration - property
2044
@dbus_service_property(_interface,
2045
signature="t",
2046
access="readwrite")
2047
def ApprovalDuration_dbus_property(self, value=None):
2048
if value is None: # get
2049
return dbus.UInt64(self.approval_duration.total_seconds()
2050
* 1000)
2051
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2052
2053
# Name - property
2054
@dbus_annotations(
2055
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2056
@dbus_service_property(_interface, signature="s", access="read")
2057
def Name_dbus_property(self):
847
2058
return dbus.String(self.name)
848
849
# fingerprint - property
850
@dbus_service_property(_interface, signature=u"s", access=u"read")
851
def fingerprint_dbus_property(self):
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
2067
# Fingerprint - property
2068
@dbus_annotations(
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
@dbus_service_property(_interface, signature="s", access="read")
2071
def Fingerprint_dbus_property(self):
852
2072
return dbus.String(self.fingerprint)
853
854
# host - property
855
@dbus_service_property(_interface, signature=u"s",
856
access=u"readwrite")
857
def host_dbus_property(self, value=None):
2073
2074
# Host - property
2075
@dbus_service_property(_interface,
2076
signature="s",
2077
access="readwrite")
2078
def Host_dbus_property(self, value=None):
858
2079
if value is None: # get
859
2080
return dbus.String(self.host)
860
self.host = value
861
# Emit D-Bus signal
862
self.PropertyChanged(dbus.String(u"host"),
863
dbus.String(value, variant_level=1))
864
865
# created - property
866
@dbus_service_property(_interface, signature=u"s", access=u"read")
867
def created_dbus_property(self):
868
return dbus.String(self._datetime_to_dbus(self.created))
869
870
# last_enabled - property
871
@dbus_service_property(_interface, signature=u"s", access=u"read")
872
def last_enabled_dbus_property(self):
873
if self.last_enabled is None:
874
return dbus.String(u"")
875
return dbus.String(self._datetime_to_dbus(self.last_enabled))
876
877
# enabled - property
878
@dbus_service_property(_interface, signature=u"b",
879
access=u"readwrite")
880
def enabled_dbus_property(self, value=None):
2081
self.host = str(value)
2082
2083
# Created - property
2084
@dbus_annotations(
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
@dbus_service_property(_interface, signature="s", access="read")
2087
def Created_dbus_property(self):
2088
return datetime_to_dbus(self.created)
2089
2090
# LastEnabled - property
2091
@dbus_service_property(_interface, signature="s", access="read")
2092
def LastEnabled_dbus_property(self):
2093
return datetime_to_dbus(self.last_enabled)
2094
2095
# Enabled - property
2096
@dbus_service_property(_interface,
2097
signature="b",
2098
access="readwrite")
2099
def Enabled_dbus_property(self, value=None):
881
2100
if value is None: # get
882
2101
return dbus.Boolean(self.enabled)
883
2102
if value:
884
2103
self.enable()
885
2104
else:
886
2105
self.disable()
887
888
# last_checked_ok - property
889
@dbus_service_property(_interface, signature=u"s",
890
access=u"readwrite")
891
def last_checked_ok_dbus_property(self, value=None):
2106
2107
# LastCheckedOK - property
2108
@dbus_service_property(_interface,
2109
signature="s",
2110
access="readwrite")
2111
def LastCheckedOK_dbus_property(self, value=None):
892
2112
if value is not None:
893
2113
self.checked_ok()
894
2114
return
895
if self.last_checked_ok is None:
896
return dbus.String(u"")
897
return dbus.String(self._datetime_to_dbus(self
898
.last_checked_ok))
899
900
# timeout - property
901
@dbus_service_property(_interface, signature=u"t",
902
access=u"readwrite")
903
def timeout_dbus_property(self, value=None):
2115
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
2122
# Expires - property
2123
@dbus_service_property(_interface, signature="s", access="read")
2124
def Expires_dbus_property(self):
2125
return datetime_to_dbus(self.expires)
2126
2127
# LastApprovalRequest - property
2128
@dbus_service_property(_interface, signature="s", access="read")
2129
def LastApprovalRequest_dbus_property(self):
2130
return datetime_to_dbus(self.last_approval_request)
2131
2132
# Timeout - property
2133
@dbus_service_property(_interface,
2134
signature="t",
2135
access="readwrite")
2136
def Timeout_dbus_property(self, value=None):
904
2137
if value is None: # get
905
return dbus.UInt64(self.timeout_milliseconds())
2138
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2139
old_timeout = self.timeout
906
2140
self.timeout = datetime.timedelta(0, 0, 0, value)
907
# Emit D-Bus signal
908
self.PropertyChanged(dbus.String(u"timeout"),
909
dbus.UInt64(value, variant_level=1))
910
if getattr(self, u"disable_initiator_tag", None) is None:
911
return
912
# Reschedule timeout
913
gobject.source_remove(self.disable_initiator_tag)
914
self.disable_initiator_tag = None
915
time_to_die = (self.
916
_timedelta_to_milliseconds((self
917
.last_checked_ok
918
+ self.timeout)
919
- datetime.datetime
920
.utcnow()))
921
if time_to_die <= 0:
922
# The timeout has passed
923
self.disable()
924
else:
925
self.disable_initiator_tag = (gobject.timeout_add
926
(time_to_die, self.disable))
927
928
# interval - property
929
@dbus_service_property(_interface, signature=u"t",
930
access=u"readwrite")
931
def interval_dbus_property(self, value=None):
932
if value is None: # get
933
return dbus.UInt64(self.interval_milliseconds())
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
2157
# ExtendedTimeout - property
2158
@dbus_service_property(_interface,
2159
signature="t",
2160
access="readwrite")
2161
def ExtendedTimeout_dbus_property(self, value=None):
2162
if value is None: # get
2163
return dbus.UInt64(self.extended_timeout.total_seconds()
2164
* 1000)
2165
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2166
2167
# Interval - property
2168
@dbus_service_property(_interface,
2169
signature="t",
2170
access="readwrite")
2171
def Interval_dbus_property(self, value=None):
2172
if value is None: # get
2173
return dbus.UInt64(self.interval.total_seconds() * 1000)
934
2174
self.interval = datetime.timedelta(0, 0, 0, value)
935
# Emit D-Bus signal
936
self.PropertyChanged(dbus.String(u"interval"),
937
dbus.UInt64(value, variant_level=1))
938
if getattr(self, u"checker_initiator_tag", None) is None:
2175
if getattr(self, "checker_initiator_tag", None) is None:
939
2176
return
940
# Reschedule checker run
941
gobject.source_remove(self.checker_initiator_tag)
942
self.checker_initiator_tag = (gobject.timeout_add
943
(value, self.start_checker))
944
self.start_checker() # Start one now, too
2177
if self.enabled:
2178
# 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
945
2183
946
# checker - property
947
@dbus_service_property(_interface, signature=u"s",
948
access=u"readwrite")
949
def checker_dbus_property(self, value=None):
2184
# Checker - property
2185
@dbus_service_property(_interface,
2186
signature="s",
2187
access="readwrite")
2188
def Checker_dbus_property(self, value=None):
950
2189
if value is None: # get
951
2190
return dbus.String(self.checker_command)
952
self.checker_command = value
953
# Emit D-Bus signal
954
self.PropertyChanged(dbus.String(u"checker"),
955
dbus.String(self.checker_command,
956
variant_level=1))
957
958
# checker_running - property
959
@dbus_service_property(_interface, signature=u"b",
960
access=u"readwrite")
961
def checker_running_dbus_property(self, value=None):
2191
self.checker_command = str(value)
2192
2193
# CheckerRunning - property
2194
@dbus_service_property(_interface,
2195
signature="b",
2196
access="readwrite")
2197
def CheckerRunning_dbus_property(self, value=None):
962
2198
if value is None: # get
963
2199
return dbus.Boolean(self.checker is not None)
964
2200
if value:
965
2201
self.start_checker()
966
2202
else:
967
2203
self.stop_checker()
968
969
# object_path - property
970
@dbus_service_property(_interface, signature=u"o", access=u"read")
971
def object_path_dbus_property(self):
972
return self.dbus_object_path # is already a dbus.ObjectPath
973
974
# secret = property
975
@dbus_service_property(_interface, signature=u"ay",
976
access=u"write", byte_arrays=True)
977
def secret_dbus_property(self, value):
978
self.secret = str(value)
979
2204
2205
# ObjectPath - property
2206
@dbus_annotations(
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2208
"org.freedesktop.DBus.Deprecated": "true"})
2209
@dbus_service_property(_interface, signature="o", access="read")
2210
def ObjectPath_dbus_property(self):
2211
return self.dbus_object_path # is already a dbus.ObjectPath
2212
2213
# 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)
2221
def Secret_dbus_property(self, value):
2222
self.secret = bytes(value)
2223
980
2224
del _interface
981
2225
982
2226
2227
class ProxyClient:
2228
def __init__(self, child_pipe, key_id, fpr, address):
2229
self._pipe = child_pipe
2230
self._pipe.send(('init', key_id, fpr, address))
2231
if not self._pipe.recv():
2232
raise KeyError(key_id or fpr)
2233
2234
def __getattribute__(self, name):
2235
if name == '_pipe':
2236
return super(ProxyClient, self).__getattribute__(name)
2237
self._pipe.send(('getattr', name))
2238
data = self._pipe.recv()
2239
if data[0] == 'data':
2240
return data[1]
2241
if data[0] == 'function':
2242
2243
def func(*args, **kwargs):
2244
self._pipe.send(('funcall', name, args, kwargs))
2245
return self._pipe.recv()[1]
2246
2247
return func
2248
2249
def __setattr__(self, name, value):
2250
if name == '_pipe':
2251
return super(ProxyClient, self).__setattr__(name, value)
2252
self._pipe.send(('setattr', name, value))
2253
2254
983
2255
class ClientHandler(socketserver.BaseRequestHandler, object):
984
2256
"""A class to handle client connections.
985
2257
986
2258
Instantiated once for each connection to handle it.
987
2259
Note: This will run in its own forked process."""
988
2260
989
2261
def handle(self):
990
logger.info(u"TCP connection from: %s",
991
unicode(self.client_address))
992
logger.debug(u"IPC Pipe FD: %d", self.server.child_pipe[1])
993
# Open IPC pipe to parent process
994
with contextlib.nested(os.fdopen(self.server.child_pipe[1],
995
u"w", 1),
996
os.fdopen(self.server.parent_pipe[0],
997
u"r", 0)) as (ipc,
998
ipc_return):
999
session = (gnutls.connection
1000
.ClientSession(self.request,
1001
gnutls.connection
1002
.X509Credentials()))
1003
1004
line = self.request.makefile().readline()
1005
logger.debug(u"Protocol version: %r", line)
1006
try:
1007
if int(line.strip().split()[0]) > 1:
1008
raise RuntimeError
1009
except (ValueError, IndexError, RuntimeError), error:
1010
logger.error(u"Unknown protocol version: %s", error)
1011
return
1012
1013
# Note: gnutls.connection.X509Credentials is really a
1014
# generic GnuTLS certificate credentials object so long as
1015
# no X.509 keys are added to it. Therefore, we can use it
1016
# here despite using OpenPGP certificates.
1017
1018
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1019
# u"+AES-256-CBC", u"+SHA1",
1020
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1021
# u"+DHE-DSS"))
2262
with contextlib.closing(self.server.child_pipe) as child_pipe:
2263
logger.info("TCP connection from: %s",
2264
str(self.client_address))
2265
logger.debug("Pipe FD: %d",
2266
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"))
1022
2274
# Use a fallback default, since this MUST be set.
1023
2275
priority = self.server.gnutls_priority
1024
2276
if priority is None:
1025
priority = u"NORMAL"
1026
(gnutls.library.functions
1027
.gnutls_priority_set_direct(session._c_object,
1028
priority, None))
1029
2277
priority = "NORMAL"
2278
gnutls.priority_set_direct(session._c_object,
2279
priority.encode("utf-8"),
2280
None)
2281
2282
# Start communication using the Mandos protocol
2283
# Get protocol number
2284
line = self.request.makefile().readline()
2285
logger.debug("Protocol version: %r", line)
2286
try:
2287
if int(line.strip().split()[0]) > 1:
2288
raise RuntimeError(line)
2289
except (ValueError, IndexError, RuntimeError) as error:
2290
logger.error("Unknown protocol version: %s", error)
2291
return
2292
2293
# Start GnuTLS connection
1030
2294
try:
1031
2295
session.handshake()
1032
except gnutls.errors.GNUTLSError, error:
1033
logger.warning(u"Handshake failed: %s", error)
2296
except gnutls.Error as error:
2297
logger.warning("Handshake failed: %s", error)
1034
2298
# Do not run session.bye() here: the session is not
1035
2299
# established. Just abandon the request.
1036
2300
return
1037
logger.debug(u"Handshake succeeded")
2301
logger.debug("Handshake succeeded")
2302
2303
approval_required = False
1038
2304
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
1039
2325
try:
1040
fpr = self.fingerprint(self.peer_certificate
1041
(session))
1042
except (TypeError, gnutls.errors.GNUTLSError), error:
1043
logger.warning(u"Bad certificate: %s", error)
2326
client = ProxyClient(child_pipe, key_id, fpr,
2327
self.client_address)
2328
except KeyError:
1044
2329
return
1045
logger.debug(u"Fingerprint: %s", fpr)
1046
1047
for c in self.server.clients:
1048
if c.fingerprint == fpr:
1049
client = c
2330
2331
if client.approval_delay:
2332
delay = client.approval_delay
2333
client.approvals_pending += 1
2334
approval_required = True
2335
2336
while True:
2337
if not client.enabled:
2338
logger.info("Client %s is disabled",
2339
client.name)
2340
if self.server.use_dbus:
2341
# Emit D-Bus signal
2342
client.Rejected("Disabled")
2343
return
2344
2345
if client.approved or not client.approval_delay:
2346
# We are approved or approval is disabled
1050
2347
break
1051
else:
1052
ipc.write(u"NOTFOUND %s %s\n"
1053
% (fpr, unicode(self.client_address)))
1054
return
1055
# Have to check if client.enabled, since it is
1056
# possible that the client was disabled since the
1057
# GnuTLS session was established.
1058
ipc.write(u"GETATTR enabled %s\n" % fpr)
1059
enabled = pickle.load(ipc_return)
1060
if not enabled:
1061
ipc.write(u"DISABLED %s\n" % client.name)
1062
return
1063
ipc.write(u"SENDING %s\n" % client.name)
1064
sent_size = 0
1065
while sent_size < len(client.secret):
1066
sent = session.send(client.secret[sent_size:])
1067
logger.debug(u"Sent: %d, remaining: %d",
1068
sent, len(client.secret)
1069
- (sent_size + sent))
1070
sent_size += sent
2348
elif client.approved is None:
2349
logger.info("Client %s needs approval",
2350
client.name)
2351
if self.server.use_dbus:
2352
# Emit D-Bus signal
2353
client.NeedApproval(
2354
client.approval_delay.total_seconds()
2355
* 1000, client.approved_by_default)
2356
else:
2357
logger.warning("Client %s was not approved",
2358
client.name)
2359
if self.server.use_dbus:
2360
# Emit D-Bus signal
2361
client.Rejected("Denied")
2362
return
2363
2364
# wait until timeout or approved
2365
time = datetime.datetime.now()
2366
client.changedstate.acquire()
2367
client.changedstate.wait(delay.total_seconds())
2368
client.changedstate.release()
2369
time2 = datetime.datetime.now()
2370
if (time2 - time) >= delay:
2371
if not client.approved_by_default:
2372
logger.warning("Client %s timed out while"
2373
" waiting for approval",
2374
client.name)
2375
if self.server.use_dbus:
2376
# Emit D-Bus signal
2377
client.Rejected("Approval timed out")
2378
return
2379
else:
2380
break
2381
else:
2382
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
2391
logger.info("Sending secret to %s", client.name)
2392
# bump the timeout using extended_timeout
2393
client.bump_timeout(client.extended_timeout)
2394
if self.server.use_dbus:
2395
# Emit D-Bus signal
2396
client.GotSecret()
2397
1071
2398
finally:
1072
session.bye()
1073
2399
if approval_required:
2400
client.approvals_pending -= 1
2401
try:
2402
session.bye()
2403
except gnutls.Error as error:
2404
logger.warning("GnuTLS bye failed",
2405
exc_info=error)
2406
1074
2407
@staticmethod
1075
2408
def peer_certificate(session):
1076
"Return the peer's OpenPGP certificate as a bytestring"
1077
# If not an OpenPGP certificate...
1078
if (gnutls.library.functions
1079
.gnutls_certificate_type_get(session._c_object)
1080
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1081
# ...do the normal thing
1082
return session.peer_certificate
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""
1083
2425
list_size = ctypes.c_uint(1)
1084
cert_list = (gnutls.library.functions
1085
.gnutls_certificate_get_peers
2426
cert_list = (gnutls.certificate_get_peers
1086
2427
(session._c_object, ctypes.byref(list_size)))
1087
2428
if not bool(cert_list) and list_size.value != 0:
1088
raise gnutls.errors.GNUTLSError(u"error getting peer"
1089
u" certificate")
2429
raise gnutls.Error("error getting peer certificate")
1090
2430
if list_size.value == 0:
1091
2431
return None
1092
2432
cert = cert_list[0]
1093
2433
return ctypes.string_at(cert.data, cert.size)
1094
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
1095
2469
@staticmethod
1096
2470
def fingerprint(openpgp):
1097
2471
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1098
2472
# New GnuTLS "datum" with the OpenPGP public key
1099
datum = (gnutls.library.types
1100
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1101
ctypes.POINTER
1102
(ctypes.c_ubyte)),
1103
ctypes.c_uint(len(openpgp))))
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)))
1104
2477
# New empty GnuTLS certificate
1105
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1106
(gnutls.library.functions
1107
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2478
crt = gnutls.openpgp_crt_t()
2479
gnutls.openpgp_crt_init(ctypes.byref(crt))
1108
2480
# Import the OpenPGP public key into the certificate
1109
(gnutls.library.functions
1110
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1111
gnutls.library.constants
1112
.GNUTLS_OPENPGP_FMT_RAW))
2481
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2482
gnutls.OPENPGP_FMT_RAW)
1113
2483
# Verify the self signature in the key
1114
2484
crtverify = ctypes.c_uint()
1115
(gnutls.library.functions
1116
.gnutls_openpgp_crt_verify_self(crt, 0,
1117
ctypes.byref(crtverify)))
2485
gnutls.openpgp_crt_verify_self(crt, 0,
2486
ctypes.byref(crtverify))
1118
2487
if crtverify.value != 0:
1119
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1120
raise (gnutls.errors.CertificateSecurityError
1121
(u"Verify failed"))
2488
gnutls.openpgp_crt_deinit(crt)
2489
raise gnutls.CertificateSecurityError(code
2490
=crtverify.value)
1122
2491
# New buffer for the fingerprint
1123
2492
buf = ctypes.create_string_buffer(20)
1124
2493
buf_len = ctypes.c_size_t()
1125
2494
# Get the fingerprint from the certificate into the buffer
1126
(gnutls.library.functions
1127
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1128
ctypes.byref(buf_len)))
2495
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2496
ctypes.byref(buf_len))
1129
2497
# Deinit the certificate
1130
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2498
gnutls.openpgp_crt_deinit(crt)
1131
2499
# Convert the buffer to a Python bytestring
1132
2500
fpr = ctypes.string_at(buf, buf_len.value)
1133
2501
# Convert the bytestring to hexadecimal notation
1134
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2502
hex_fpr = binascii.hexlify(fpr).upper()
1135
2503
return hex_fpr
1136
2504
1137
2505
1138
class ForkingMixInWithPipes(socketserver.ForkingMixIn, object):
1139
"""Like socketserver.ForkingMixIn, but also pass a pipe pair."""
2506
class MultiprocessingMixIn:
2507
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2508
2509
def sub_process_main(self, request, address):
2510
try:
2511
self.finish_request(request, address)
2512
except Exception:
2513
self.handle_error(request, address)
2514
self.close_request(request)
2515
2516
def process_request(self, request, address):
2517
"""Start a new process to process the request."""
2518
proc = multiprocessing.Process(target=self.sub_process_main,
2519
args=(request, address))
2520
proc.start()
2521
return proc
2522
2523
2524
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2525
""" adds a pipe to the MixIn """
2526
1140
2527
def process_request(self, request, client_address):
1141
2528
"""Overrides and wraps the original process_request().
1142
2529
1143
2530
This function creates a new pipe in self.pipe
1144
2531
"""
1145
self.child_pipe = os.pipe() # Child writes here
1146
self.parent_pipe = os.pipe() # Parent writes here
1147
super(ForkingMixInWithPipes,
1148
self).process_request(request, client_address)
1149
# Close unused ends for parent
1150
os.close(self.parent_pipe[0]) # close read end
1151
os.close(self.child_pipe[1]) # close write end
1152
self.add_pipe_fds(self.child_pipe[0], self.parent_pipe[1])
1153
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2532
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2533
2534
proc = MultiprocessingMixIn.process_request(self, request,
2535
client_address)
2536
self.child_pipe.close()
2537
self.add_pipe(parent_pipe, proc)
2538
2539
def add_pipe(self, parent_pipe, proc):
1154
2540
"""Dummy function; override as necessary"""
1155
os.close(child_pipe_fd)
1156
os.close(parent_pipe_fd)
1157
1158
1159
class IPv6_TCPServer(ForkingMixInWithPipes,
1160
socketserver.TCPServer, object):
2541
raise NotImplementedError()
2542
2543
2544
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2545
socketserver.TCPServer):
1161
2546
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1162
2547
1163
2548
Attributes:
1164
2549
enabled: Boolean; whether this server is activated yet
1165
2550
interface: None or a network interface name (string)
1166
2551
use_ipv6: Boolean; to use IPv6 or not
1167
2552
"""
2553
1168
2554
def __init__(self, server_address, RequestHandlerClass,
1169
interface=None, use_ipv6=True):
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
"""
1170
2561
self.interface = interface
1171
2562
if use_ipv6:
1172
2563
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.
1173
2591
socketserver.TCPServer.__init__(self, server_address,
1174
2592
RequestHandlerClass)
2593
1175
2594
def server_bind(self):
1176
2595
"""This overrides the normal server_bind() function
1177
2596
to bind to an interface if one was specified, and also NOT to
1178
2597
bind to an address or port if they were not specified."""
2598
global SO_BINDTODEVICE
1179
2599
if self.interface is not None:
1180
2600
if SO_BINDTODEVICE is None:
1181
logger.error(u"SO_BINDTODEVICE does not exist;"
1182
u" cannot bind to interface %s",
1183
self.interface)
1184
else:
1185
try:
1186
self.socket.setsockopt(socket.SOL_SOCKET,
1187
SO_BINDTODEVICE,
1188
str(self.interface
1189
+ u'\0'))
1190
except socket.error, error:
1191
if error[0] == errno.EPERM:
1192
logger.error(u"No permission to"
1193
u" bind to interface %s",
1194
self.interface)
1195
elif error[0] == errno.ENOPROTOOPT:
1196
logger.error(u"SO_BINDTODEVICE not available;"
1197
u" cannot bind to interface %s",
1198
self.interface)
1199
else:
1200
raise
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
1201
2622
# Only bind(2) the socket if we really need to.
1202
2623
if self.server_address[0] or self.server_address[1]:
2624
if self.server_address[1]:
2625
self.allow_reuse_address = True
1203
2626
if not self.server_address[0]:
1204
2627
if self.address_family == socket.AF_INET6:
1205
any_address = u"::" # in6addr_any
2628
any_address = "::" # in6addr_any
1206
2629
else:
1207
any_address = socket.INADDR_ANY
2630
any_address = "0.0.0.0" # INADDR_ANY
1208
2631
self.server_address = (any_address,
1209
2632
self.server_address[1])
1210
2633
elif not self.server_address[1]:
1211
self.server_address = (self.server_address[0],
1212
0)
2634
self.server_address = (self.server_address[0], 0)
1213
2635
# if self.interface:
1214
2636
# self.server_address = (self.server_address[0],
1215
2637
# 0, # port
1221
2643
1222
2644
class MandosServer(IPv6_TCPServer):
1223
2645
"""Mandos server.
1224
2646
1225
2647
Attributes:
1226
2648
clients: set of Client objects
1227
2649
gnutls_priority GnuTLS priority string
1228
2650
use_dbus: Boolean; to emit D-Bus signals or not
1229
1230
Assumes a gobject.MainLoop event loop.
2651
2652
Assumes a GLib.MainLoop event loop.
1231
2653
"""
2654
1232
2655
def __init__(self, server_address, RequestHandlerClass,
1233
interface=None, use_ipv6=True, clients=None,
1234
gnutls_priority=None, use_dbus=True):
2656
interface=None,
2657
use_ipv6=True,
2658
clients=None,
2659
gnutls_priority=None,
2660
use_dbus=True,
2661
socketfd=None):
1235
2662
self.enabled = False
1236
2663
self.clients = clients
1237
2664
if self.clients is None:
1238
self.clients = set()
2665
self.clients = {}
1239
2666
self.use_dbus = use_dbus
1240
2667
self.gnutls_priority = gnutls_priority
1241
2668
IPv6_TCPServer.__init__(self, server_address,
1242
2669
RequestHandlerClass,
1243
interface = interface,
1244
use_ipv6 = use_ipv6)
2670
interface=interface,
2671
use_ipv6=use_ipv6,
2672
socketfd=socketfd)
2673
1245
2674
def server_activate(self):
1246
2675
if self.enabled:
1247
2676
return socketserver.TCPServer.server_activate(self)
2677
1248
2678
def enable(self):
1249
2679
self.enabled = True
1250
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2680
2681
def add_pipe(self, parent_pipe, proc):
1251
2682
# Call "handle_ipc" for both data and EOF events
1252
gobject.io_add_watch(child_pipe_fd,
1253
gobject.IO_IN | gobject.IO_HUP,
1254
functools.partial(self.handle_ipc,
1255
reply_fd
1256
=parent_pipe_fd))
1257
def handle_ipc(self, source, condition, reply_fd=None,
1258
file_objects={}):
1259
condition_names = {
1260
gobject.IO_IN: u"IN", # There is data to read.
1261
gobject.IO_OUT: u"OUT", # Data can be written (without
1262
# blocking).
1263
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1264
gobject.IO_ERR: u"ERR", # Error condition.
1265
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1266
# broken, usually for pipes and
1267
# sockets).
1268
}
1269
conditions_string = ' | '.join(name
1270
for cond, name in
1271
condition_names.iteritems()
1272
if cond & condition)
1273
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1274
conditions_string)
1275
1276
# Turn the pipe file descriptors into Python file objects
1277
if source not in file_objects:
1278
file_objects[source] = os.fdopen(source, u"r", 1)
1279
if reply_fd not in file_objects:
1280
file_objects[reply_fd] = os.fdopen(reply_fd, u"w", 0)
1281
1282
# Read a line from the file object
1283
cmdline = file_objects[source].readline()
1284
if not cmdline: # Empty line means end of file
1285
# close the IPC pipes
1286
file_objects[source].close()
1287
del file_objects[source]
1288
file_objects[reply_fd].close()
1289
del file_objects[reply_fd]
1290
1291
# Stop calling this function
1292
return False
1293
1294
logger.debug(u"IPC command: %r", cmdline)
1295
1296
# Parse and act on command
1297
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1298
1299
if cmd == u"NOTFOUND":
1300
fpr, address = args.split(None, 1)
1301
logger.warning(u"Client not found for fingerprint: %s, ad"
1302
u"dress: %s", fpr, address)
1303
if self.use_dbus:
1304
# Emit D-Bus signal
1305
mandos_dbus_service.ClientNotFound(fpr, address)
1306
elif cmd == u"DISABLED":
1307
for client in self.clients:
1308
if client.name == args:
1309
logger.warning(u"Client %s is disabled", args)
1310
if self.use_dbus:
1311
# Emit D-Bus signal
1312
client.Rejected()
1313
break
1314
else:
1315
logger.error(u"Unknown client %s is disabled", args)
1316
elif cmd == u"SENDING":
1317
for client in self.clients:
1318
if client.name == args:
1319
logger.info(u"Sending secret to %s", client.name)
1320
client.checked_ok()
1321
if self.use_dbus:
1322
# Emit D-Bus signal
1323
client.GotSecret()
1324
break
1325
else:
1326
logger.error(u"Sending secret to unknown client %s",
1327
args)
1328
elif cmd == u"GETATTR":
1329
attr_name, fpr = args.split(None, 1)
1330
for client in self.clients:
1331
if client.fingerprint == fpr:
1332
attr_value = getattr(client, attr_name, None)
1333
logger.debug("IPC reply: %r", attr_value)
1334
pickle.dump(attr_value, file_objects[reply_fd])
1335
break
1336
else:
1337
logger.error(u"Client %s on address %s requesting "
1338
u"attribute %s not found", fpr, address,
1339
attr_name)
1340
pickle.dump(None, file_objects[reply_fd])
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):
2694
# error, or the other end of multiprocessing.Pipe has closed
2695
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2696
# Wait for other process to exit
2697
proc.join()
2698
return False
2699
2700
# Read a request from the child
2701
request = parent_pipe.recv()
2702
command = request[0]
2703
2704
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:
2716
client = c
2717
break
2718
else:
2719
logger.info("Client not found for key ID: %s, address"
2720
": %s", key_id or fpr, address)
2721
if self.use_dbus:
2722
# Emit D-Bus signal
2723
mandos_dbus_service.ClientNotFound(key_id or fpr,
2724
address[0])
2725
parent_pipe.send(False)
2726
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))
2735
parent_pipe.send(True)
2736
# remove the old hook in favor of the new above hook on
2737
# same fileno
2738
return False
2739
if command == 'funcall':
2740
funcname = request[1]
2741
args = request[2]
2742
kwargs = request[3]
2743
2744
parent_pipe.send(('data', getattr(client_object,
2745
funcname)(*args,
2746
**kwargs)))
2747
2748
if command == 'getattr':
2749
attrname = request[1]
2750
if isinstance(client_object.__getattribute__(attrname),
2751
collections.Callable):
2752
parent_pipe.send(('function', ))
2753
else:
2754
parent_pipe.send((
2755
'data', client_object.__getattribute__(attrname)))
2756
2757
if command == 'setattr':
2758
attrname = request[1]
2759
value = request[2]
2760
setattr(client_object, attrname, value)
2761
2762
return True
2763
2764
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
1341
2856
else:
1342
logger.error(u"Unknown IPC command: %r", cmdline)
1343
1344
# Keep calling this function
1345
return True
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
1346
2862
1347
2863
1348
2864
def string_to_delta(interval):
1349
2865
"""Parse a string and return a datetime.timedelta
1350
1351
>>> string_to_delta(u'7d')
2866
2867
>>> string_to_delta('7d')
1352
2868
datetime.timedelta(7)
1353
>>> string_to_delta(u'60s')
2869
>>> string_to_delta('60s')
1354
2870
datetime.timedelta(0, 60)
1355
>>> string_to_delta(u'60m')
2871
>>> string_to_delta('60m')
1356
2872
datetime.timedelta(0, 3600)
1357
>>> string_to_delta(u'24h')
2873
>>> string_to_delta('24h')
1358
2874
datetime.timedelta(1)
1359
>>> string_to_delta(u'1w')
2875
>>> string_to_delta('1w')
1360
2876
datetime.timedelta(7)
1361
>>> string_to_delta(u'5m 30s')
2877
>>> string_to_delta('5m 30s')
1362
2878
datetime.timedelta(0, 330)
1363
2879
"""
2880
2881
try:
2882
return rfc3339_duration_to_delta(interval)
2883
except ValueError:
2884
pass
2885
1364
2886
timevalue = datetime.timedelta(0)
1365
2887
for s in interval.split():
1366
2888
try:
1367
suffix = unicode(s[-1])
2889
suffix = s[-1]
1368
2890
value = int(s[:-1])
1369
if suffix == u"d":
2891
if suffix == "d":
1370
2892
delta = datetime.timedelta(value)
1371
elif suffix == u"s":
2893
elif suffix == "s":
1372
2894
delta = datetime.timedelta(0, value)
1373
elif suffix == u"m":
2895
elif suffix == "m":
1374
2896
delta = datetime.timedelta(0, 0, 0, 0, value)
1375
elif suffix == u"h":
2897
elif suffix == "h":
1376
2898
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1377
elif suffix == u"w":
2899
elif suffix == "w":
1378
2900
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1379
2901
else:
1380
raise ValueError(u"Unknown suffix %r" % suffix)
1381
except (ValueError, IndexError), e:
1382
raise ValueError(e.message)
2902
raise ValueError("Unknown suffix {!r}".format(suffix))
2903
except IndexError as e:
2904
raise ValueError(*(e.args))
1383
2905
timevalue += delta
1384
2906
return timevalue
1385
2907
1386
2908
1387
def if_nametoindex(interface):
1388
"""Call the C function if_nametoindex(), or equivalent
1389
1390
Note: This function cannot accept a unicode string."""
1391
global if_nametoindex
1392
try:
1393
if_nametoindex = (ctypes.cdll.LoadLibrary
1394
(ctypes.util.find_library(u"c"))
1395
.if_nametoindex)
1396
except (OSError, AttributeError):
1397
logger.warning(u"Doing if_nametoindex the hard way")
1398
def if_nametoindex(interface):
1399
"Get an interface index the hard way, i.e. using fcntl()"
1400
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1401
with contextlib.closing(socket.socket()) as s:
1402
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1403
struct.pack(str(u"16s16x"),
1404
interface))
1405
interface_index = struct.unpack(str(u"I"),
1406
ifreq[16:20])[0]
1407
return interface_index
1408
return if_nametoindex(interface)
1409
1410
1411
def daemon(nochdir = False, noclose = False):
2909
def daemon(nochdir=False, noclose=False):
1412
2910
"""See daemon(3). Standard BSD Unix function.
1413
2911
1414
2912
This should really exist as os.daemon, but it doesn't (yet)."""
1415
2913
if os.fork():
1416
2914
sys.exit()
1417
2915
os.setsid()
1418
2916
if not nochdir:
1419
os.chdir(u"/")
2917
os.chdir("/")
1420
2918
if os.fork():
1421
2919
sys.exit()
1422
2920
if not noclose:
1423
2921
# Close all standard open file descriptors
1424
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2922
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1425
2923
if not stat.S_ISCHR(os.fstat(null).st_mode):
1426
2924
raise OSError(errno.ENODEV,
1427
u"%s not a character device"
1428
% os.path.devnull)
2925
"{} not a character device"
2926
.format(os.devnull))
1429
2927
os.dup2(null, sys.stdin.fileno())
1430
2928
os.dup2(null, sys.stdout.fileno())
1431
2929
os.dup2(null, sys.stderr.fileno())
1434
2932
1435
2933
1436
2934
def main():
1437
2935
1438
2936
##################################################################
1439
2937
# Parsing of options, both command line and config file
1440
1441
parser = optparse.OptionParser(version = "%%prog %s" % version)
1442
parser.add_option("-i", u"--interface", type=u"string",
1443
metavar="IF", help=u"Bind to interface IF")
1444
parser.add_option("-a", u"--address", type=u"string",
1445
help=u"Address to listen for requests on")
1446
parser.add_option("-p", u"--port", type=u"int",
1447
help=u"Port number to receive requests on")
1448
parser.add_option("--check", action=u"store_true",
1449
help=u"Run self-test")
1450
parser.add_option("--debug", action=u"store_true",
1451
help=u"Debug mode; run in foreground and log to"
1452
u" terminal")
1453
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1454
u" priority string (see GnuTLS documentation)")
1455
parser.add_option("--servicename", type=u"string",
1456
metavar=u"NAME", help=u"Zeroconf service name")
1457
parser.add_option("--configdir", type=u"string",
1458
default=u"/etc/mandos", metavar=u"DIR",
1459
help=u"Directory to search for configuration"
1460
u" files")
1461
parser.add_option("--no-dbus", action=u"store_false",
1462
dest=u"use_dbus", help=u"Do not provide D-Bus"
1463
u" system bus interface")
1464
parser.add_option("--no-ipv6", action=u"store_false",
1465
dest=u"use_ipv6", help=u"Do not use IPv6")
1466
options = parser.parse_args()[0]
1467
1468
if options.check:
1469
import doctest
1470
doctest.testmod()
1471
sys.exit()
1472
2938
2939
parser = argparse.ArgumentParser()
2940
parser.add_argument("-v", "--version", action="version",
2941
version="%(prog)s {}".format(version),
2942
help="show version number and exit")
2943
parser.add_argument("-i", "--interface", metavar="IF",
2944
help="Bind to interface IF")
2945
parser.add_argument("-a", "--address",
2946
help="Address to listen for requests on")
2947
parser.add_argument("-p", "--port", type=int,
2948
help="Port number to receive requests on")
2949
parser.add_argument("--check", action="store_true",
2950
help="Run self-test")
2951
parser.add_argument("--debug", action="store_true",
2952
help="Debug mode; run in foreground and log"
2953
" to terminal", default=None)
2954
parser.add_argument("--debuglevel", metavar="LEVEL",
2955
help="Debug level for stdout output")
2956
parser.add_argument("--priority", help="GnuTLS"
2957
" priority string (see GnuTLS documentation)")
2958
parser.add_argument("--servicename",
2959
metavar="NAME", help="Zeroconf service name")
2960
parser.add_argument("--configdir",
2961
default="/etc/mandos", metavar="DIR",
2962
help="Directory to search for configuration"
2963
" files")
2964
parser.add_argument("--no-dbus", action="store_false",
2965
dest="use_dbus", help="Do not provide D-Bus"
2966
" system bus interface", default=None)
2967
parser.add_argument("--no-ipv6", action="store_false",
2968
dest="use_ipv6", help="Do not use IPv6",
2969
default=None)
2970
parser.add_argument("--no-restore", action="store_false",
2971
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")
2976
parser.add_argument("--statedir", metavar="DIR",
2977
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
2984
options = parser.parse_args()
2985
1473
2986
# Default values for config file for server-global settings
1474
server_defaults = { u"interface": u"",
1475
u"address": u"",
1476
u"port": u"",
1477
u"debug": u"False",
1478
u"priority":
1479
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1480
u"servicename": u"Mandos",
1481
u"use_dbus": u"True",
1482
u"use_ipv6": u"True",
1483
}
1484
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
1485
3010
# Parse config file for server-global settings
1486
server_config = configparser.SafeConfigParser(server_defaults)
3011
server_config = configparser.ConfigParser(server_defaults)
1487
3012
del server_defaults
1488
server_config.read(os.path.join(options.configdir,
1489
u"mandos.conf"))
1490
# Convert the SafeConfigParser object to a dict
3013
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3014
# Convert the ConfigParser object to a dict
1491
3015
server_settings = server_config.defaults()
1492
3016
# Use the appropriate methods on the non-string config options
1493
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1494
server_settings[option] = server_config.getboolean(u"DEFAULT",
3017
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3018
"foreground", "zeroconf"):
3019
server_settings[option] = server_config.getboolean("DEFAULT",
1495
3020
option)
1496
3021
if server_settings["port"]:
1497
server_settings["port"] = server_config.getint(u"DEFAULT",
1498
u"port")
3022
server_settings["port"] = server_config.getint("DEFAULT",
3023
"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"])
1499
3033
del server_config
1500
3034
1501
3035
# Override the settings from the config file with command line
1502
3036
# options, if set.
1503
for option in (u"interface", u"address", u"port", u"debug",
1504
u"priority", u"servicename", u"configdir",
1505
u"use_dbus", u"use_ipv6"):
3037
for option in ("interface", "address", "port", "debug",
3038
"priority", "servicename", "configdir", "use_dbus",
3039
"use_ipv6", "debuglevel", "restore", "statedir",
3040
"socket", "foreground", "zeroconf"):
1506
3041
value = getattr(options, option)
1507
3042
if value is not None:
1508
3043
server_settings[option] = value
1509
3044
del options
1510
3045
# Force all strings to be unicode
1511
3046
for option in server_settings.keys():
1512
if type(server_settings[option]) is str:
1513
server_settings[option] = unicode(server_settings[option])
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
1514
3057
# Now we have our good server settings in "server_settings"
1515
3058
1516
3059
##################################################################
1517
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
1518
3066
# For convenience
1519
debug = server_settings[u"debug"]
1520
use_dbus = server_settings[u"use_dbus"]
1521
use_ipv6 = server_settings[u"use_ipv6"]
1522
1523
if not debug:
1524
syslogger.setLevel(logging.WARNING)
1525
console.setLevel(logging.WARNING)
1526
1527
if server_settings[u"servicename"] != u"Mandos":
1528
syslogger.setFormatter(logging.Formatter
1529
(u'Mandos (%s) [%%(process)d]:'
1530
u' %%(levelname)s: %%(message)s'
1531
% server_settings[u"servicename"]))
1532
3067
debug = server_settings["debug"]
3068
debuglevel = server_settings["debuglevel"]
3069
use_dbus = server_settings["use_dbus"]
3070
use_ipv6 = server_settings["use_ipv6"]
3071
stored_state_path = os.path.join(server_settings["statedir"],
3072
stored_state_file)
3073
foreground = server_settings["foreground"]
3074
zeroconf = server_settings["zeroconf"]
3075
3076
if debug:
3077
initlogger(debug, logging.DEBUG)
3078
else:
3079
if not debuglevel:
3080
initlogger(debug)
3081
else:
3082
level = getattr(logging, debuglevel.upper())
3083
initlogger(debug, level)
3084
3085
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
1533
3091
# Parse config file with clients
1534
client_defaults = { u"timeout": u"1h",
1535
u"interval": u"5m",
1536
u"checker": u"fping -q -- %%(host)s",
1537
u"host": u"",
1538
}
1539
client_config = configparser.SafeConfigParser(client_defaults)
1540
client_config.read(os.path.join(server_settings[u"configdir"],
1541
u"clients.conf"))
1542
3092
client_config = configparser.ConfigParser(Client.client_defaults)
3093
client_config.read(os.path.join(server_settings["configdir"],
3094
"clients.conf"))
3095
1543
3096
global mandos_dbus_service
1544
3097
mandos_dbus_service = None
1545
1546
tcp_server = MandosServer((server_settings[u"address"],
1547
server_settings[u"port"]),
1548
ClientHandler,
1549
interface=server_settings[u"interface"],
1550
use_ipv6=use_ipv6,
1551
gnutls_priority=
1552
server_settings[u"priority"],
1553
use_dbus=use_dbus)
1554
pidfilename = u"/var/run/mandos.pid"
1555
try:
1556
pidfile = open(pidfilename, u"w")
1557
except IOError:
1558
logger.error(u"Could not open file %r", pidfilename)
1559
1560
try:
1561
uid = pwd.getpwnam(u"_mandos").pw_uid
1562
gid = pwd.getpwnam(u"_mandos").pw_gid
1563
except KeyError:
1564
try:
1565
uid = pwd.getpwnam(u"mandos").pw_uid
1566
gid = pwd.getpwnam(u"mandos").pw_gid
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
1567
3128
except KeyError:
1568
try:
1569
uid = pwd.getpwnam(u"nobody").pw_uid
1570
gid = pwd.getpwnam(u"nobody").pw_gid
1571
except KeyError:
1572
uid = 65534
1573
gid = 65534
3129
continue
3130
else:
3131
uid = 65534
3132
gid = 65534
1574
3133
try:
1575
3134
os.setgid(gid)
1576
3135
os.setuid(uid)
1577
except OSError, error:
1578
if error[0] != errno.EPERM:
1579
raise error
1580
1581
# Enable all possible GnuTLS debugging
3136
if debug:
3137
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3138
gid))
3139
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
1582
3145
if debug:
3146
# Enable all possible GnuTLS debugging
3147
1583
3148
# "Use a log level over 10 to enable all debugging options."
1584
3149
# - GnuTLS manual
1585
gnutls.library.functions.gnutls_global_set_log_level(11)
1586
1587
@gnutls.library.types.gnutls_log_func
3150
gnutls.global_set_log_level(11)
3151
3152
@gnutls.log_func
1588
3153
def debug_gnutls(level, string):
1589
logger.debug(u"GnuTLS: %s", string[:-1])
1590
1591
(gnutls.library.functions
1592
.gnutls_global_set_log_function(debug_gnutls))
1593
3154
logger.debug("GnuTLS: %s", string[:-1])
3155
3156
gnutls.global_set_log_function(debug_gnutls)
3157
3158
# Redirect stdin so all checkers get /dev/null
3159
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3160
os.dup2(null, sys.stdin.fileno())
3161
if null > 2:
3162
os.close(null)
3163
3164
# Need to fork before connecting to D-Bus
3165
if not foreground:
3166
# Close all input and output, do double fork, etc.
3167
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
1594
3174
global main_loop
1595
3175
# From the Avahi example code
1596
DBusGMainLoop(set_as_default=True )
1597
main_loop = gobject.MainLoop()
3176
DBusGMainLoop(set_as_default=True)
3177
main_loop = GLib.MainLoop()
1598
3178
bus = dbus.SystemBus()
1599
3179
# End of Avahi example code
1600
3180
if use_dbus:
1601
3181
try:
1602
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1603
bus, do_not_queue=True)
1604
except dbus.exceptions.NameExistsException, e:
1605
logger.error(unicode(e) + u", disabling D-Bus")
3182
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)
1606
3190
use_dbus = False
1607
server_settings[u"use_dbus"] = False
3191
server_settings["use_dbus"] = False
1608
3192
tcp_server.use_dbus = False
1609
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1610
service = AvahiService(name = server_settings[u"servicename"],
1611
servicetype = u"_mandos._tcp",
1612
protocol = protocol, bus = bus)
1613
if server_settings["interface"]:
1614
service.interface = (if_nametoindex
1615
(str(server_settings[u"interface"])))
1616
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
3204
global multiprocessing_manager
3205
multiprocessing_manager = multiprocessing.Manager()
3206
1617
3207
client_class = Client
1618
3208
if use_dbus:
1619
client_class = functools.partial(ClientDBus, bus = bus)
1620
tcp_server.clients.update(set(
1621
client_class(name = section,
1622
config= dict(client_config.items(section)))
1623
for section in client_config.sections()))
3209
client_class = functools.partial(ClientDBus, bus=bus)
3210
3211
client_settings = Client.config_parser(client_config)
3212
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
3223
# Get client data and settings from last running state.
3224
if server_settings["restore"]:
3225
try:
3226
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"))
3276
os.remove(stored_state_path)
3277
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)
3284
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
3296
# Decide which value to use after restoring saved state.
3297
# We have three different values: Old config file,
3298
# new config file, and saved state.
3299
# New config value takes precedence if it differs from old
3300
# config value, otherwise use saved state.
3301
for name, value in client_settings[client_name].items():
3302
try:
3303
# For each value in new config, check if it
3304
# differs from the old config value (Except for
3305
# the "secret" attribute)
3306
if (name != "secret"
3307
and (value !=
3308
old_client_settings[client_name][name])):
3309
client[name] = value
3310
except KeyError:
3311
pass
3312
3313
# 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"]))
3333
client["enabled"] = False
3334
else:
3335
client["expires"] = (
3336
datetime.datetime.utcnow()
3337
+ client["timeout"])
3338
logger.debug("Last checker succeeded,"
3339
" keeping {} enabled".format(
3340
client_name))
3341
try:
3342
client["secret"] = pgp.decrypt(
3343
client["encrypted_secret"],
3344
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
1624
3367
if not tcp_server.clients:
1625
logger.warning(u"No clients defined")
1626
1627
if debug:
1628
# Redirect stdin so all checkers get /dev/null
1629
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1630
os.dup2(null, sys.stdin.fileno())
1631
if null > 2:
1632
os.close(null)
1633
else:
1634
# No console logging
1635
logger.removeHandler(console)
1636
# Close all input and output, do double fork, etc.
1637
daemon()
1638
1639
try:
1640
with pidfile:
3368
logger.warning("No clients defined")
3369
3370
if not foreground:
3371
if pidfile is not None:
1641
3372
pid = os.getpid()
1642
pidfile.write(str(pid) + "\n")
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)
1643
3379
del pidfile
1644
except IOError:
1645
logger.error(u"Could not write to file %r with PID %d",
1646
pidfilename, pid)
1647
except NameError:
1648
# "pidfile" was never created
1649
pass
1650
del pidfilename
1651
1652
if not debug:
1653
signal.signal(signal.SIGINT, signal.SIG_IGN)
1654
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1655
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1656
3380
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
1657
3386
if use_dbus:
1658
class MandosDBusService(dbus.service.Object):
3387
3388
@alternate_dbus_interfaces(
3389
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3390
class MandosDBusService(DBusObjectWithObjectManager):
1659
3391
"""A D-Bus proxy object"""
3392
1660
3393
def __init__(self):
1661
dbus.service.Object.__init__(self, bus, u"/")
1662
_interface = u"se.bsnet.fukt.Mandos"
1663
1664
@dbus.service.signal(_interface, signature=u"o")
3394
dbus.service.Object.__init__(self, bus, "/")
3395
3396
_interface = "se.recompile.Mandos"
3397
3398
@dbus.service.signal(_interface, signature="o")
1665
3399
def ClientAdded(self, objpath):
1666
3400
"D-Bus signal"
1667
3401
pass
1668
1669
@dbus.service.signal(_interface, signature=u"ss")
1670
def ClientNotFound(self, fingerprint, address):
3402
3403
@dbus.service.signal(_interface, signature="ss")
3404
def ClientNotFound(self, key_id, address):
1671
3405
"D-Bus signal"
1672
3406
pass
1673
1674
@dbus.service.signal(_interface, signature=u"os")
3407
3408
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3409
"true"})
3410
@dbus.service.signal(_interface, signature="os")
1675
3411
def ClientRemoved(self, objpath, name):
1676
3412
"D-Bus signal"
1677
3413
pass
1678
1679
@dbus.service.method(_interface, out_signature=u"ao")
3414
3415
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3416
"true"})
3417
@dbus.service.method(_interface, out_signature="ao")
1680
3418
def GetAllClients(self):
1681
3419
"D-Bus method"
1682
return dbus.Array(c.dbus_object_path
1683
for c in tcp_server.clients)
1684
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"})
1685
3425
@dbus.service.method(_interface,
1686
out_signature=u"a{oa{sv}}")
3426
out_signature="a{oa{sv}}")
1687
3427
def GetAllClientsWithProperties(self):
1688
3428
"D-Bus method"
1689
3429
return dbus.Dictionary(
1690
((c.dbus_object_path, c.GetAll(u""))
1691
for c in tcp_server.clients),
1692
signature=u"oa{sv}")
1693
1694
@dbus.service.method(_interface, in_signature=u"o")
3430
{c.dbus_object_path: c.GetAll(
3431
"se.recompile.Mandos.Client")
3432
for c in tcp_server.clients.values()},
3433
signature="oa{sv}")
3434
3435
@dbus.service.method(_interface, in_signature="o")
1695
3436
def RemoveClient(self, object_path):
1696
3437
"D-Bus method"
1697
for c in tcp_server.clients:
3438
for c in tcp_server.clients.values():
1698
3439
if c.dbus_object_path == object_path:
1699
tcp_server.clients.remove(c)
3440
del tcp_server.clients[c.name]
1700
3441
c.remove_from_connection()
1701
# Don't signal anything except ClientRemoved
3442
# Don't signal the disabling
1702
3443
c.disable(quiet=True)
1703
# Emit D-Bus signal
1704
self.ClientRemoved(object_path, c.name)
3444
# Emit D-Bus signal for removal
3445
self.client_removed_signal(c)
1705
3446
return
1706
3447
raise KeyError(object_path)
1707
3448
1708
3449
del _interface
1709
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
1710
3487
mandos_dbus_service = MandosDBusService()
1711
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
1712
3494
def cleanup():
1713
3495
"Cleanup function; run on exit"
1714
service.cleanup()
1715
3496
if zeroconf:
3497
service.cleanup()
3498
3499
mp.active_children()
3500
wn.close()
3501
if not (tcp_server.clients or client_settings):
3502
return
3503
3504
# Store client before exiting. Secrets are encrypted with key
3505
# based on what config file has. If config file is
3506
# removed/edited, old secret will thus be unrecovable.
3507
clients = {}
3508
with PGPEngine() as pgp:
3509
for client in tcp_server.clients.values():
3510
key = client_settings[client.name]["secret"]
3511
client.encrypted_secret = pgp.encrypt(client.secret,
3512
key)
3513
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):
3521
exclude.add(name)
3522
3523
client_dict["encrypted_secret"] = (client
3524
.encrypted_secret)
3525
for attr in client.client_structure:
3526
if attr not in exclude:
3527
client_dict[attr] = getattr(client, attr)
3528
3529
clients[client.name] = client_dict
3530
del client_settings[client.name]["secret"]
3531
3532
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)
3543
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)
3555
raise
3556
3557
# Delete all clients, and settings from config
1716
3558
while tcp_server.clients:
1717
client = tcp_server.clients.pop()
3559
name, client = tcp_server.clients.popitem()
1718
3560
if use_dbus:
1719
3561
client.remove_from_connection()
1720
client.disable_hook = None
1721
# Don't signal anything except ClientRemoved
3562
# Don't signal the disabling
1722
3563
client.disable(quiet=True)
3564
# Emit D-Bus signal for removal
1723
3565
if use_dbus:
1724
# Emit D-Bus signal
1725
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1726
client.name)
1727
3566
mandos_dbus_service.client_removed_signal(client)
3567
client_settings.clear()
3568
1728
3569
atexit.register(cleanup)
1729
1730
for client in tcp_server.clients:
3570
3571
for client in tcp_server.clients.values():
1731
3572
if use_dbus:
1732
# Emit D-Bus signal
1733
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1734
client.enable()
1735
3573
# Emit D-Bus signal for adding
3574
mandos_dbus_service.client_added_signal(client)
3575
# Need to initiate checking of clients
3576
if client.enabled:
3577
client.init_checker()
3578
1736
3579
tcp_server.enable()
1737
3580
tcp_server.server_activate()
1738
3581
1739
3582
# Find out what port we got
1740
service.port = tcp_server.socket.getsockname()[1]
3583
if zeroconf:
3584
service.port = tcp_server.socket.getsockname()[1]
1741
3585
if use_ipv6:
1742
logger.info(u"Now listening on address %r, port %d,"
1743
" flowinfo %d, scope_id %d"
1744
% tcp_server.socket.getsockname())
3586
logger.info("Now listening on address %r, port %d,"
3587
" flowinfo %d, scope_id %d",
3588
*tcp_server.socket.getsockname())
1745
3589
else: # IPv4
1746
logger.info(u"Now listening on address %r, port %d"
1747
% tcp_server.socket.getsockname())
1748
1749
#service.interface = tcp_server.socket.getsockname()[3]
1750
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
1751
3595
try:
1752
# From the Avahi example code
1753
try:
1754
service.activate()
1755
except dbus.exceptions.DBusException, error:
1756
logger.critical(u"DBusException: %s", error)
1757
cleanup()
1758
sys.exit(1)
1759
# End of Avahi example code
1760
1761
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1762
lambda *args, **kwargs:
1763
(tcp_server.handle_request
1764
(*args[2:], **kwargs) or True))
1765
1766
logger.debug(u"Starting main loop")
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
3612
logger.debug("Starting main loop")
1767
3613
main_loop.run()
1768
except AvahiError, error:
1769
logger.critical(u"AvahiError: %s", error)
3614
except AvahiError as error:
3615
logger.critical("Avahi Error", exc_info=error)
1770
3616
cleanup()
1771
3617
sys.exit(1)
1772
3618
except KeyboardInterrupt:
1773
3619
if debug:
1774
print >> sys.stderr
1775
logger.debug(u"Server received KeyboardInterrupt")
1776
logger.debug(u"Server exiting")
3620
print("", file=sys.stderr)
3621
logger.debug("Server received KeyboardInterrupt")
3622
logger.debug("Server exiting")
1777
3623
# Must run before the D-Bus bus name gets deregistered
1778
3624
cleanup()
1779
3625
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
1780
3643
if __name__ == '__main__':
1781
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()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0