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