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