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