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