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